--- title: Get the details of an ingestion slug: import-test-pdf/XiKJ-get-the-details-of-an-ingestion createdAt: 2025-10-29T08:15:26.754Z --- { "id": "KASoUHrQwlq3_mM9j7OfJ", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}", "servers": [ { "url": "https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}", "description": "RS Provisioning Integration API" }, { "url": "https://provisioning.rs.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}", "description": "RS Provisioning Production API" } ], "name": "Get the details of an ingestion", "description": "Query the details of an ingestion", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "ingestionIdentifier", "type": "string", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB", "description": "The ingestion identifier" } ], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "entityId", "type": "string", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB", "description": "Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "The ingestion details", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The details of an ingestion", "customType": "IngestionDetails", "schema": [], "modelRef": "#/components/schemas/IngestionDetails", "complexItems": [ { "name": "object", "schema": [ { "name": "identifier", "kind": "required", "type": "string", "description": "", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "dataFeedIdentifier", "kind": "required", "type": "string", "description": "", "example": "85DA13C0-6288-11EE-AE5D-0800200C9A66" }, { "name": "startedTimestamp", "kind": "required", "type": "string", "description": "Timestamp when the ingestion was started", "example": "2020-05-28T14:07:17Z" }, { "name": "ingestedTimestamp", "kind": "required", "type": "string", "description": "Timestamp when the ingestion itself was completed, while further processing of submissions continues", "example": "2020-05-28T14:07:17Z" }, { "name": "client", "kind": "required", "type": "string", "description": "", "example": "31F5D854-2358-4E90-9348-38C803118F8F" }, { "name": "actor", "kind": "required", "type": "string", "description": "", "example": "8F90F460-6288-11EE-AE5D-0800200C9A66" }, { "name": "failureReason", "kind": "required", "type": "string", "description": "", "example": "When status is failed provides the reason of failure" }, { "name": "permissions", "kind": "required", "type": "object", "description": "Experimental. The permissions the user has on a resource.", "modelRef": "#/components/schemas/UploadPermissions", "customType": "UploadPermissions", "schema": [ { "name": "canReprocess", "kind": "optional", "type": "boolean", "description": "Experimental. Whether a user can reprocess the resource.", "example": true }, { "name": "canIgnore", "kind": "optional", "type": "boolean", "description": "Whether a user can ignore the resource", "example": true } ] }, { "name": "type", "kind": "required", "type": "string", "description": "The ingestion type\n
x-extensible-enum: \n - SINGLE_ENTRY\n - UPLOAD\n - REPROCESS\n - REPROCESSED_UPLOAD\n\n", "modelRef": "#/components/schemas/IngestionType", "customType": "IngestionType", "schema": [] }, { "name": "status", "kind": "required", "type": "string", "description": "The status of the single entry\n
x-extensible-enum: \n - PROCESSED\n - FAILED\n - IGNORED\n\n", "modelRef": "#/components/schemas/SingleEntryStatus", "customType": "SingleEntryStatus", "schema": [] }, { "name": "contentType", "kind": "required", "type": "string", "description": "The type of the upload\n
x-extensible-enum: \n - CSV\n - JSON\n - XML\n - UNSUPPORTED\n\n", "modelRef": "#/components/schemas/IngestionContentType", "customType": "IngestionContentType", "schema": [] }, { "name": "deliveryMechanism", "kind": "required", "type": "string", "description": "The delivery mechanism that upload was ingested\n
x-extensible-enum: \n - API\n - UI\n - KOR_SFTP\n - CLIENT_SFTP\n - KOR_KAFKA\n\n", "modelRef": "#/components/schemas/DeliveryMechanism", "customType": "DeliveryMechanism", "schema": [] }, { "name": "entryPayload", "kind": "optional", "type": "string", "description": "the client payload for a single entry ingestion", "example": "" } ], "modelRef": "#/components/schemas/SingleEntryDetails", "customType": "SingleEntryDetails" }, { "name": "object", "schema": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "dataFeedIdentifier", "kind": "optional", "type": "string", "description": "", "example": "85DA13C0-6288-11EE-AE5D-0800200C9A66" }, { "name": "startedTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the ingestion was started", "example": "2020-05-28T14:07:17Z" }, { "name": "ingestedTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the ingestion itself was completed, while further processing of submissions continues", "example": "2020-05-28T14:07:17Z" }, { "name": "client", "kind": "optional", "type": "string", "description": "", "example": "31F5D854-2358-4E90-9348-38C803118F8F" }, { "name": "actor", "kind": "optional", "type": "string", "description": "", "example": "8F90F460-6288-11EE-AE5D-0800200C9A66" }, { "name": "failureReason", "kind": "optional", "type": "string", "description": "", "example": "When status is failed provides the reason of failure" }, { "name": "permissions", "kind": "optional", "type": "object", "description": "Experimental. The permissions the user has on a resource.", "modelRef": "#/components/schemas/UploadPermissions", "customType": "UploadPermissions", "schema": [ { "name": "canReprocess", "kind": "optional", "type": "boolean", "description": "Experimental. Whether a user can reprocess the resource.", "example": true }, { "name": "canIgnore", "kind": "optional", "type": "boolean", "description": "Whether a user can ignore the resource", "example": true } ] }, { "name": "type", "kind": "required", "type": "string", "description": "The ingestion type\n
x-extensible-enum: \n - SINGLE_ENTRY\n - UPLOAD\n - REPROCESS\n - REPROCESSED_UPLOAD\n\n", "modelRef": "#/components/schemas/IngestionType", "customType": "IngestionType", "schema": [] }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the upload\n
x-extensible-enum: \n - RECEIVED\n - UPLOADED\n - PROCESSING\n - PROCESSED\n - FAILED\n - IGNORED\n\n", "modelRef": "#/components/schemas/UploadStatus", "customType": "UploadStatus", "schema": [] }, { "name": "fileName", "kind": "optional", "type": "string", "description": "", "example": "filename.json" }, { "name": "contentType", "kind": "optional", "type": "string", "description": "The type of the upload\n
x-extensible-enum: \n - CSV\n - JSON\n - XML\n - UNSUPPORTED\n\n", "modelRef": "#/components/schemas/IngestionContentType", "customType": "IngestionContentType", "schema": [] }, { "name": "deliveryMechanism", "kind": "optional", "type": "string", "description": "The delivery mechanism that upload was ingested\n
x-extensible-enum: \n - API\n - UI\n - KOR_SFTP\n - CLIENT_SFTP\n - KOR_KAFKA\n\n", "modelRef": "#/components/schemas/DeliveryMechanism", "customType": "DeliveryMechanism", "schema": [] }, { "name": "ignoredTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the failed ingestion was ignored", "example": "2020-05-28T14:07:17Z" }, { "name": "detectedSubmissions", "kind": "optional", "type": "integer", "description": "Total number of submissions found in the payload, regardless of their outcome", "example": 0 }, { "name": "identifiedSubmissions", "kind": "optional", "type": "integer", "description": "Number of submissions found in the payload for which a (client) trade identifier and event startedTimestamp were successfully extracted", "example": 0 }, { "name": "identificationFailedSubmissions", "kind": "optional", "type": "integer", "description": "Number of submissions for which no (client) trade identifier or event startedTimestamp could be extracted", "example": 0 } ], "modelRef": "#/components/schemas/Upload", "customType": "Upload" }, { "name": "object", "schema": [ { "name": "identifier", "kind": "required", "type": "string", "description": "", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "dataFeedIdentifier", "kind": "required", "type": "string", "description": "", "example": "85DA13C0-6288-11EE-AE5D-0800200C9A66" }, { "name": "startedTimestamp", "kind": "required", "type": "string", "description": "Timestamp when the ingestion was started", "example": "2020-05-28T14:07:17Z" }, { "name": "ingestedTimestamp", "kind": "required", "type": "string", "description": "Timestamp when the ingestion itself was completed, while further processing of submissions continues", "example": "2020-05-28T14:07:17Z" }, { "name": "client", "kind": "required", "type": "string", "description": "", "example": "31F5D854-2358-4E90-9348-38C803118F8F" }, { "name": "actor", "kind": "required", "type": "string", "description": "", "example": "8F90F460-6288-11EE-AE5D-0800200C9A66" }, { "name": "failureReason", "kind": "required", "type": "string", "description": "", "example": "When status is failed provides the reason of failure" }, { "name": "permissions", "kind": "required", "type": "object", "description": "Experimental. The permissions the user has on a resource.", "modelRef": "#/components/schemas/UploadPermissions", "customType": "UploadPermissions", "schema": [ { "name": "canReprocess", "kind": "optional", "type": "boolean", "description": "Experimental. Whether a user can reprocess the resource.", "example": true }, { "name": "canIgnore", "kind": "optional", "type": "boolean", "description": "Whether a user can ignore the resource", "example": true } ] }, { "name": "type", "kind": "required", "type": "string", "description": "The ingestion type\n
x-extensible-enum: \n - SINGLE_ENTRY\n - UPLOAD\n - REPROCESS\n - REPROCESSED_UPLOAD\n\n", "modelRef": "#/components/schemas/IngestionType", "customType": "IngestionType", "schema": [] }, { "name": "status", "kind": "required", "type": "string", "description": "The status of the reprocess\n
x-extensible-enum: \n - PROCESSING\n - PROCESSED\n - FAILED\n - IGNORED\n\n", "modelRef": "#/components/schemas/ReprocessStatus", "customType": "ReprocessStatus", "schema": [] }, { "name": "ignoredTimestamp", "kind": "required", "type": "string", "description": "Timestamp when the failed ingestion was ignored", "example": "2020-05-28T14:07:17Z" }, { "name": "detectedSubmissions", "kind": "required", "type": "integer", "description": "Total number of submissions found in the payload, regardless of their outcome", "example": 0 }, { "name": "rehydratedSubmissions", "kind": "required", "type": "integer", "description": "Number of submissions found to be reprocessed that have successfully been rehydrated from storage", "example": 0 }, { "name": "releasedSubmissions", "kind": "required", "type": "integer", "description": "Number of rehydrated submissions which have been successfully released as new identified submissions in order for reprocessing", "example": 0 }, { "name": "failedSubmissions", "kind": "required", "type": "integer", "description": "Number of submissions which failed to be reprocessed, resulting in a rollback of the entire reprocess", "example": 0 }, { "name": "failures", "kind": "optional", "type": "array", "description": "The list of failed submissions and their failure reason (limited to 100)", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "submissionIdentifier", "kind": "optional", "type": "string", "description": "", "example": "2F12F644-7B9A-422C-838A-6A56FC4C4E22" }, { "name": "regulatoryMessageIdentifier", "kind": "optional", "type": "string", "description": "", "example": "A1C63F49-9561-4EDB-A224-4B12E125E3AF" }, { "name": "failureReason", "kind": "optional", "type": "string", "description": "", "example": "The submission was not found in cold storage" } ] } ], "modelRef": "#/components/schemas/ReprocessDetails", "customType": "ReprocessDetails" }, { "name": "object", "schema": [ { "name": "identifier", "kind": "optional", "type": "string", "description": "", "example": "EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB" }, { "name": "dataFeedIdentifier", "kind": "optional", "type": "string", "description": "", "example": "85DA13C0-6288-11EE-AE5D-0800200C9A66" }, { "name": "startedTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the ingestion was started", "example": "2020-05-28T14:07:17Z" }, { "name": "ingestedTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the ingestion itself was completed, while further processing of submissions continues", "example": "2020-05-28T14:07:17Z" }, { "name": "client", "kind": "optional", "type": "string", "description": "", "example": "31F5D854-2358-4E90-9348-38C803118F8F" }, { "name": "actor", "kind": "optional", "type": "string", "description": "", "example": "8F90F460-6288-11EE-AE5D-0800200C9A66" }, { "name": "failureReason", "kind": "optional", "type": "string", "description": "", "example": "When status is failed provides the reason of failure" }, { "name": "permissions", "kind": "optional", "type": "object", "description": "Experimental. The permissions the user has on a resource.", "modelRef": "#/components/schemas/UploadPermissions", "customType": "UploadPermissions", "schema": [ { "name": "canReprocess", "kind": "optional", "type": "boolean", "description": "Experimental. Whether a user can reprocess the resource.", "example": true }, { "name": "canIgnore", "kind": "optional", "type": "boolean", "description": "Whether a user can ignore the resource", "example": true } ] }, { "name": "type", "kind": "required", "type": "string", "description": "The ingestion type\n
x-extensible-enum: \n - SINGLE_ENTRY\n - UPLOAD\n - REPROCESS\n - REPROCESSED_UPLOAD\n\n", "modelRef": "#/components/schemas/IngestionType", "customType": "IngestionType", "schema": [] }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the upload\n
x-extensible-enum: \n - RECEIVED\n - UPLOADED\n - PROCESSING\n - PROCESSED\n - FAILED\n - IGNORED\n\n", "modelRef": "#/components/schemas/UploadStatus", "customType": "UploadStatus", "schema": [] }, { "name": "contentType", "kind": "optional", "type": "string", "description": "The type of the upload\n
x-extensible-enum: \n - CSV\n - JSON\n - XML\n - UNSUPPORTED\n\n", "modelRef": "#/components/schemas/IngestionContentType", "customType": "IngestionContentType", "schema": [] }, { "name": "deliveryMechanism", "kind": "optional", "type": "string", "description": "The delivery mechanism that upload was ingested\n
x-extensible-enum: \n - API\n - UI\n - KOR_SFTP\n - CLIENT_SFTP\n - KOR_KAFKA\n\n", "modelRef": "#/components/schemas/DeliveryMechanism", "customType": "DeliveryMechanism", "schema": [] }, { "name": "ignoredTimestamp", "kind": "optional", "type": "string", "description": "Timestamp when the failed ingestion was ignored", "example": "2020-05-28T14:07:17Z" }, { "name": "detectedSubmissions", "kind": "optional", "type": "integer", "description": "Total number of submissions found in the payload, regardless of their outcome", "example": 0 }, { "name": "identifiedSubmissions", "kind": "optional", "type": "integer", "description": "Number of submissions found in the payload for which a (client) trade identifier and event startedTimestamp were successfully extracted", "example": 0 }, { "name": "identificationFailedSubmissions", "kind": "optional", "type": "integer", "description": "Number of submissions for which no (client) trade identifier or event startedTimestamp could be extracted", "example": 0 }, { "name": "dataFeedIdentifier", "kind": "optional", "type": "string", "description": "", "example": "85DA13C0-6288-11EE-AE5D-0800200C9A66" }, { "name": "uploadIdentifierToReprocess", "kind": "optional", "type": "string", "description": "", "example": "85DA13C0-6288-11EE-AE5D-0800200C9A66" }, { "name": "rowNumbers", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/components/schemas/ReprocessedUploadDetails", "customType": "ReprocessedUploadDetails" } ], "complexType": "oneOf", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true }, { "statusCode": "405", "description": "Method Not Allowed", "jsonExample": "", "isExpanded": true }, { "statusCode": "406", "description": "Not Acceptable", "jsonExample": "", "isExpanded": true }, { "statusCode": "415", "description": "Unsupported Media Type", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true }, { "statusCode": "504", "description": "Gateway Timeout", "jsonExample": "", "isExpanded": true }, { "statusCode": "default", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier} \\\n --header 'accept: application/json'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://provisioning.rs.int.{environment}.korfinancial.com/ingestions/{ingestionIdentifier}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// The ingestion details\n{}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request\n" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-3-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-4-404", "language": "404", "code": "// Not Found\n" }, { "id": "response-5-405", "language": "405", "code": "// Method Not Allowed\n" }, { "id": "response-6-406", "language": "406", "code": "// Not Acceptable\n" }, { "id": "response-7-415", "language": "415", "code": "// Unsupported Media Type\n" }, { "id": "response-8-500", "language": "500", "code": "// Internal Server Error\n" }, { "id": "response-9-504", "language": "504", "code": "// Gateway Timeout\n" }, { "id": "response-10-default", "language": "default", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }