v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Upload Doc

The Upload Doc API allows the API user to upload documents for the International Remittance for Education. (These documents are checked at the bank's end for every transaction)

post/v1/client/accounts/upload-doc

Query parameters

userAccountIdstring required

userAccountId of remitter/student/beneficiary

fileNamestring

Name of file to be uploaded

docTypestring required

docType should be either of the following values: ["PAN", "PASSPORT"]

fileTypestring required

Allowed file types are 'pdf', 'jpg', 'jpeg', 'png'

sidestring required

Which side of doc is to be uploaded: ["front","back"]

Headers

api-keystring required

API Key

auth-keystring required

Auth key generated via the "Generate Auth key API"

userIdstring required

User Id as generated via the "Create Account (sign-Up) API". Identifier of an individual user, you can map this to the User identification at your end.

Request body

filestring binary required

File which should be less than 5Mb

Response

200

statusinteger

messagestring

Example response

{
  "status": 200,
  "message": "Success",
  "data": {
    "message": "PAN added",
    "accountDocId": "7e1d6877-0fc5-4e3e-847f-c86e699e2861"
  }
}