Skip to main content

Information Requests Management

There are two main types of Information Requests:

  • TransactionInfoRequest (TIR) – simple structure, you reply directly to the TIR.
  • OnboardingInfoRequest (OIR) – complex structure consisting of multiple onboardingDocumentRequestIds.

This document describes how to retrieve, manage, and respond to both.

📁 Onboarding Information Requests (OIR)​

1. Monitor OIRs​

Check for active OIRs via one of the following methods:

  • Subscribe to the onboardingInformationRequestStatusChanged webhook.
    See: Webhook Events
  • Check active onboarding information requests:
    GET /kyc/onboarding-information-requests
    See: Get Onboarding Info Requests

2. Retrieve OIR Details​

GET /kyc/onboarding-information-requests/{id}
See: Get Onboarding Info Request by ID

  • Parse each onboardingDocumentRequestId from the response.

3. Upload Requested Documents​

For each onboardingDocumentRequestId, upload the requested document:

POST /kyc/public/{customerId}/upload/{documentRequestId}
See: Post Upload Document (OIR)

  • If a document is unavailable or you want to leave a comment, fill in the comment field.

4. Check OIR Status After Each Upload​

After each upload, check the current state so that you return to end-user only non-answered items:

GET /kyc/onboarding-information-requests/{id}

  • The OIR remains isActive: true until each onboardingDocumentRequestId is marked as either:
    • isSkipped: true
    • isUploaded: true

Example OIR Items:

{
  "id": "20e29abb-c26b-44d0-b01b-a553488449ac",
  "documentType": 60,
  "documentTypeName": "Selfie",
  "isUploaded": false,
  "isSkipped": false
},
{
  "id": "2f167d80-7f1f-47a7-9e34-1c2134e3d55f",
  "documentType": 54,
  "documentTypeName": "Government/Nationality issued ID Card",
  "isUploaded": false,
  "isSkipped": false
},
{
  "id": "4ac10026-bea5-4b6d-85f5-ed0bb2daaeec",
  "documentType": 8,
  "documentTypeName": "Source of Wealth Corroboration Document",
  "isUploaded": false,
  "isSkipped": false
},
{
  "id": "9e0fa905-52d8-4a06-9320-3f939539693e",
  "documentType": 56,
  "documentTypeName": "Certified copy of Passport - Photo and Information, and Signature pages required",
  "isUploaded": false,
  "isSkipped": false
}

💼 Transaction Information Requests (TIR)​

1. Monitor TIRs​

Check for active TIRs using any of the following methods:

2. Retrieve TIR Details​

GET /transaction-case/information_request/{informationRequestId}
See: Get Transaction Information Request

3. Upload Supporting Documents​

Upload documents one by one:

POST / DELETE /transaction-case/customers/{customerId}/file/upload
See: Upload Document / Delete Draft Document

  • Specify DocumentType: RequestInfoDocument
  • Save/cache the document IDs returned in the response.

4. Reply to TIR​

Attach document IDs and include a message:

POST /transaction-case/{informationRequestId}/reply
See: Post Add Note to Transaction Case

Example Request:

{
  "message": "Additional verification documents attached.",
  "documentIds": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
}