List Beneficiary KYC Documents

Get a list of KYC documents attached to a Parent Beneficiary

get/kyc-beneficiaries/{beneficiaryId}/documents

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/kyc-beneficiaries/{beneficiaryId}/documents
  • Auth
    API key in header Authorization

Path parameters

beneficiaryIdstring required

id of the Parent Beneficiary from the Create Beneficiary request.

Response

200

idstring
documentCategorystring
imageFormatstring
imageUrlstring

Example response

[
  {
    "id": "f2b37b68-5e11-4ab1-873c-2af53f6e7554",
    "documentCategory": "NATIONAL_ID_FRONT",
    "imageFormat": "JPEG",
    "imageUrl": "https://storage.googleapis.com/openpayd-dev/user_service/kyc_documents/verification-documentc28f35ed-9015-4bac-90ae-c9cee75a0c3b-20c2abf1-1c02-4bf2-8fda-4c696448a47a.JPEG?GoogleAccessId=ozan-storage-account@ozanwallet-182009.iam.gserviceaccount.com&Expires=1592232276&Signature=0do%2B3Bv4ui0UuHNbxfvq2RwUysODsvyC3w1g9g%2BMX35jq52mbrukbP1rHgWH4PgkMZe87eOBhEHfbeHxKE3%2BLRU7S761jtwD0NTkg2%2BJZ09IQxUQP8dUrUq5vZQkZTyBPtfEflhpPeQBTBonhO8gl0azZwZCYEY1p0R13243YyWbARmjPRqcihTz9lrzBJHBbEkJ6bd6plewDDwqFaRu7R2oDxYy843hVEF3yBBmcKm2nW5IIlGORBhiuvt1fGrhygBGqqi4SLD7LAfquW1u5dyKMZdDfG5OpUli%2FQqcUmvnfu2L5oFNH6VTIr4yd22pvh%2F3g85XHNXpxUoYPPigqHw%3D%3D"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.