Get a document
POST
/api/kyc/getThis service allows you to retrieve a document from a merchant or a customer via their identifier.
If you don't fill in Email
, Id
or ClientId
, the document will be searched on your account.
Request
Body Params application/x-www-form-urlencoded
DocumentId
string
required
Unique document identifier
Email
string
optional
Easytransac merchant email address
<= 128 characters
Id
number
optional
Easytransac merchant identifier
ClientId
string
optional
Easytransac customer identifier
Signature
string
required
Signature to verify the integrity of the data sent
Responses
Response(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
Code
integer
optional
Example:
0
Signature
string
optional
Example:
1f51786246a940677afe71f6968972fd46500bd1
Result
object
optional
Id
string
optional
Example:
WEX35JSM9G
DocumentType
string
optional
Allowed values:
ACTIVITY_PROOFADDRESS_PROOFARTICLES_OF_ASSOCIATIONBANK_DETAILSBENEFICIARYBENEFICIARY_BACKBENEFICIARY2BENEFICIARY2_BACKBENEFICIARY3BENEFICIARY3_BACKCOMMERCIAL_REGISTERDRIVER_LICENSEDRIVER_LICENSE_BACKFAMILY_BOOKGENERAL_MEETINGIDENTITY_PROOFIDENTITY_PROOF_BACKMARRIAGE_CERTIFICATEOTHEROTHER2OTHER3PASSPORTRECEIPT_STATEMENTREGISTRATION_PROOFRESIDENCE_PERMITRESIDENCE_PERMIT_BACKSELFIESHAREHOLDER_DECLARATIONSHAREHOLDER_DECLARATION2SIGNATURETAX_NOTICEVITAL_CARDVITAL_CARD_BACKVDI_CERTIFICATEALCOHOL_LICENSEEMPOWERMENT
Example:
ARTICLES_OF_ASSOCIATION
Status
string
optional
Allowed values:
pendingvalidinvalid
Example:
valid
Date
string
optional
Example:
2015-11-17 08:58:38
DateUpdated
string
optional
Example:
2015-11-17 08:59:04
Comment
string
optional
Example:
just a comment
Example
{
"Code": 0,
"Signature": "1f51786246a940677afe71f6968972fd46500bd1",
"Result": {
"Id": "WEX35JSM9G",
"DocumentType": "ACTIVITY_PROOF",
"Status": "pending",
"Date": "2015-11-17 08:58:38",
"DateUpdated": "2015-11-17 08:59:04",
"Comment": "just a comment"
}
}
Modified at 3 months ago