Check Sender Document

POST

/remit-api/v1/transactions/documents/check

Use this endpoint to check whether Balad already holds a sender identity document (for example, a passport) for a sender identity number. If it does, you don't need to upload the document again. Send the returned document_id as sender_identifier_document_id in Create transaction.

How it works

Check: call this endpoint with the sender's sender_identity_no.

If has_document is true: send document_id as sender_identifier_document_id in Create transaction.

If has_document is false: upload the document with Request Sender Document Upload URL, then create the transaction with its document_id.

Notes

Rule	Value
Scope	Only documents that your account uploaded are checked
Matching	`sender_identity_no` is matched without leading or trailing spaces and is not case-sensitive
Result	The latest document stored for that identity number

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "sender_identity_no": "A12345678"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://gateway-sandbox.balad.tech/remit-api/v1/transactions/documents/check' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "sender_identity_no": "A12345678"
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Examples

Success - document foundSuccess - no document

{
    "data": {
        "sender_identity_no": "A12345678",
        "has_document": true,
        "document_id": "8f1c2a4e-3b7d-4c55-9a2e-6f0d1b7c9e21"
    },
    "errors": null
}

🟠400Validation error

Request Sender Document Upload URL

Reconciliation