Add Beneficiary KYC Document

Add a KYC document to a Parent Beneficiary

post/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.

Request body

documentCategorystring required

PASSPORT, DRIVER_LICENSE_FRONT, DRIVER_LICENSE_BACK, NATIONAL_ID_FRONT, NATIONAL_ID_BACK, UTILITY_BILL, BANK_STATEMENT, OTHER

imageDatastring required

Base64 encoded file to be uploaded

imageFormatstring required

JPEG, BMP, PNG, JPG, PDF, DOC, DOCX

Response

200

idstring

documentCategorystring

imageFormatstring

imageUrlstring

Example response

{
  "id": "79c77a96-9da6-4406-9869-c6202cb3d62d",
  "documentCategory": "PASSPORT",
  "imageFormat": "JPEG",
  "imageUrl": "https://storage.googleapis.com/openpayd-dev/user_service/kyc_documents/verification-documentc28f35ed-9015-4bac-90ae-c9cee75a0c3b-8418e4d3-bf8b-4a21-ab25-c5985fae9127.JPEG?GoogleAccessId=ozan-storage-account@ozanwallet-182009.iam.gserviceaccount.com&Expires=1592232363&Signature=wdT5f7b3zUmnvfBwispBJroPbXhfNvx%2FCZjacRKiZxjWtjz4tpTmeqUP4gxsnrDoxCow6vTM2vbj1Pq7syYd1JOFZHrIYscv8dcspF%2FltrYOiZYF1%2BH4E2trTZ5hI2Z2VmIT0Jq5Exs6PHqNrywfXrRR5QXSU8iu9qpzPQVaO9Ysb3H5pt3QP%2F2%2BLmwJz%2Fj%2BMeSLWFyq3JzPa1sll%2FAYrc3KwSjAunUjmkairNhW1LzRhafZjWhkbQ3jggcH%2BTOvpW1tF6JqkIscpKc1iNEyu%2BJBCzAYk6QkKq54tyrZXfxSQ%2FRLYU8xFTg7l3XyXiMCAGqzv%2BaTzC2ertEr%2BgG72GA%3D%3D"
}

Changes

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