---
title: "Sumsub ingestion status changed"
method: POST
path: "kyc-connector.sumsub.ingestion.status-changed"
tags: ["Ingestions", "Sumsub"]
---

# Sumsub ingestion status changed

`POST kyc-connector.sumsub.ingestion.status-changed` (webhook)

The Sumsub ingestion status has been changed.

## Headers

- `webhook-id` string, required
- `webhook-timestamp` integer, required
- `webhook-signature` string, required

## Payload

- SumsubIngestionWebhookEvent: The webhook event information.
  - `id` string, uuid, required: The id of the event.
  - `type` string, required: The type of event.
  - `createdAt` string, date-time, required: The date and time when the event was created.
  - `data` object, required: The event payload.
    - `ingestion` SumsubIngestion, required
      - `id` string, required: The id of the ingestion.
      - `userId` string, required: The identifier of the user associated with the ingestion.
      - `status` 'queued' | 'running' | 'finished', required: The status of the ingestion.
      - `processes` string[], required: The list of processes requested to ingest.
      - `provider` string, required: The provider of the ingestion.
      - `parameters` object, required: The parameters associated with the ingestion.
        - `shareToken` string, required: The Sumsub shareable token.
      - `result` object: The result of each process associated with the ingestion.
        - `profile` object: The profile process result.
          - `status` 'processing' | 'completed' | 'failed', required: The status associated with the process.
          - `data` IngestionResultProfileData: The extracted profile data.
            - `fullName` string: The full legal name.
            - `birthdate` string, date: The date of birth.
            - `birthplace` object: The place of birth.
              - …
            - `primaryCitizenship` string: The primary citizenship country.
          - `error` SumsubIngestionResultProcessError: The error information associated with the process.
            - `code` 'unknown_error' | 'workflow_error' | 'provider_data_readiness_timeout_exceeded' | 'provider_data_not_available' | 'provider_data_invalid' | 'provider_file_download_failed' | 'dependent_process_failed' | 'operation_not_allowed' | 'sumsub_client_error' | 'sumsub_applicant_review_state_invalid': The error code.
            - `message` string: A human-readable message providing more details about the error.
            - `hint` string: A human-readable message providing hints to resolve the error.
            - `step` 'fetch-provider-data' | 'download-provider-files' | 'update-kyc-process': The step where the error occurred.
            - `details` object: Additional information about the error reported.
        - `address` object: The address process result.
          - `status` 'processing' | 'completed' | 'failed', required: The status associated with the process.
          - `data` IngestionResultAddressData: The extracted address data.
            - `country` string: The country of the address.
            - `subdivision` string: The subdivision of the address.
            - `city` string: The city of the address.
            - `line1` string: The first line of the address.
            - `line2` string: The second line of the address.
            - `postalCode` string: The postal code of the address.
          - `error` SumsubIngestionResultProcessError: The error information associated with the process.
            - `code` 'unknown_error' | 'workflow_error' | 'provider_data_readiness_timeout_exceeded' | 'provider_data_not_available' | 'provider_data_invalid' | 'provider_file_download_failed' | 'dependent_process_failed' | 'operation_not_allowed' | 'sumsub_client_error' | 'sumsub_applicant_review_state_invalid': The error code.
            - `message` string: A human-readable message providing more details about the error.
            - `hint` string: A human-readable message providing hints to resolve the error.
            - `step` 'fetch-provider-data' | 'download-provider-files' | 'update-kyc-process': The step where the error occurred.
            - `details` object: Additional information about the error reported.
        - `identity` object: The identity process result.
          - `status` 'processing' | 'completed' | 'failed', required: The status associated with the process.
          - `data` IngestionResultIdentityData: The extracted identity data.
            - `document` object: The identity document information.
              - …
            - `person` object: The person information.
              - …
            - `verifiedAt` string, date-time: The date and time when the identity was verified.
          - `files` object[]: The list of files downloaded during ingestion related to the process.
            - `id` string: The identifier of the file.
            - `category` 'document' | 'image' | 'video': The category of the file.
            - `context` string: The context of the file in relation to the process.
            - `contentType` string: The content-type of the file.
            - `size` integer: The size of the file in bytes.
            - `providerDetails` object: Provider-specific details about the file.
          - `error` SumsubIngestionResultProcessError: The error information associated with the process.
            - `code` 'unknown_error' | 'workflow_error' | 'provider_data_readiness_timeout_exceeded' | 'provider_data_not_available' | 'provider_data_invalid' | 'provider_file_download_failed' | 'dependent_process_failed' | 'operation_not_allowed' | 'sumsub_client_error' | 'sumsub_applicant_review_state_invalid': The error code.
            - `message` string: A human-readable message providing more details about the error.
            - `hint` string: A human-readable message providing hints to resolve the error.
            - `step` 'fetch-provider-data' | 'download-provider-files' | 'update-kyc-process': The step where the error occurred.
            - `details` object: Additional information about the error reported.
        - `proofOfAddress` object: The proof-of-address process result.
          - `status` 'processing' | 'completed' | 'failed', required: The status associated with the process.
          - `data` IngestionResultProofOfAddressData: The extracted proof-of-address data.
            - `person` object: The person information.
              - …
            - `verifiedAt` string, date-time: The date and time when the proof-of-address was verified.
          - `files` object[]: The list of files downloaded during ingestion related to the process.
            - `id` string: The identifier of the file.
            - `category` 'document' | 'image' | 'video': The category of the file.
            - `context` string: The context of the file in relation to the process.
            - `contentType` string: The content-type of the file.
            - `size` integer: The size of the file in bytes.
            - `providerDetails` object: Provider-specific details about the file.
          - `error` SumsubIngestionResultProcessError: The error information associated with the process.
            - `code` 'unknown_error' | 'workflow_error' | 'provider_data_readiness_timeout_exceeded' | 'provider_data_not_available' | 'provider_data_invalid' | 'provider_file_download_failed' | 'dependent_process_failed' | 'operation_not_allowed' | 'sumsub_client_error' | 'sumsub_applicant_review_state_invalid': The error code.
            - `message` string: A human-readable message providing more details about the error.
            - `hint` string: A human-readable message providing hints to resolve the error.
            - `step` 'fetch-provider-data' | 'download-provider-files' | 'update-kyc-process': The step where the error occurred.
            - `details` object: Additional information about the error reported.
      - `createdAt` string, date-time, required: The time at which the ingestion was created.
      - `updatedAt` string, date-time, required: The time at which the ingestion was last updated.
      - `startedAt` string, date-time: The time at which the ingestion was started.
      - `finishedAt` string, date-time: The time at which the ingestion was finished.

## Acknowledgement `200`

Return a 200 status to indicate that the data was received successfully.

---

[API](https://skmtc.dev/uphold/apis/kyc-connectors-api.md) - [All operations](https://skmtc.dev/uphold/apis/kyc-connectors-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uphold/apis/kyc-connectors-api/revisions/1a51aeae24f7?raw)