Recipient Document

Add a document for a recipient

Recipient document may be required based on your spec sheet.

Details

Field	Type	Description
documentType	String	Type of the recipient's documen
uploadedFile	String	File in png/ pdf/ jpeg/ jpg
documentIdNumber	String	Document identification number

Add a Recipient Document

You can use this API to add a recipient document.

POST /v2/senders/{{senderId}}/recipients/{{recipientId}}/documents

Details

Field	Required	Type	Description
documentType	No	String	Type of the recipient's document
uploadedFile	Yes	String	File in png/ pdf/ jpeg/ jpg
documentIdNumber	No	String	Document identification number

Request Sample

curl --location --request POST '{{URL}}/v2/senders/{{senderId}}/recipients/{{recipientId}}/documents' \
--header 'X-Client-Id: clientId \
--header 'X-Client-Secret: clientsecret\
--form 'documentType=receiver passport' \
--form 'uploadedFile=@/home/Pictures/test.png' \
--form 'documentIdNumber=123456'

Response Sample

{
   "test_field": "test_value",
   "id": "26a8aede-fbdb-41c6-a332-ab8b2822348a",
   "documentType": "receiver pasport",
   "documentIdNumber": "123456",
   "uploadedDate": "2023-05-02"
}

Get Recipient Document

You can view the recent document submitted for the recipient using this document.

GET /v2/senders/{{senderId}}/recipients/{{recipientId}}/documents

Request Sample

curl --location --request GET '{{URL}}/v2/senders/{{senderId}}/recipients/{{recipientId}}/documents' \
--header 'X-Client-Id: clientId' \
--header 'X-Client-Secret: clientsecret'

Response Sample

{
   "test_field": "test_value",
   "results": [
       {
           "id": "26a8aede-fbdb-41c6-a332-ab8b2822348a",
           "fileName": "RECEIVER_IDENTITY_2023-05-02T02%3A46%3A43.475.png",
           "frontImageLink": LINK,
           "documentType": "receiver passport",
           "documentIdNumber": "1221424242",
           "uploadedDate": "2023-05-02"
       }
   ],
   "paging": {
       "total_count": 1
   }
}