API
HomeEasytransac
HomeEasytransac
  1. API - Document
  • Start
    • API Domain Usage
    • Get an API key
    • Communication
  • Documentation
    • Errors
      • ApiError codes
    • Webhooks
      • PUSH Method
      • PULL Method
  • V2
    • Overview
    • Authentication
      • JWT access token - Generate
        POST
    • Endpoints
      • Open Banking
        • Open Banking - Initialize
      • SDD
        • SDD - Mandate - Create
        • SDD - Mandate - Debit
        • SDD - Mandate - Get status
      • Transaction
        • Transaction - Get status
  • V1
    • Documentation
      • Signature
    • Authentication
      • Overview
      • Security
      • PSD2 and 3DSecure
    • API - Payment
      • Recurring payments
      • Card payment
      • 1-click payment
      • SEPA Direct Debit
      • Transfer (Open Banking)
      • Payment page
      • Cancel a payment page
      • Resend the payment page
      • P2P Transfert
      • Update a subscription
      • Status
      • Refund
      • Capture
      • Cancellation
      • List of cards
      • List of IBANs
      • History
      • Payment requests
      • Card information
    • API - User
      • Add a merchant
      • Update a merchant
      • Search for a merchant
      • List of movements
      • Make a payout
      • List all payouts
      • Add a logo
      • Get the activity
      • Update activity
    • API - Document
      • Add a document
        POST
      • Get a document
        POST
      • List documents
        POST
  1. API - Document

List documents

Sandbox
https://api.sandbox.easytransac.com/v2
Sandbox
https://api.sandbox.easytransac.com/v2
POST
/api/kyc/find
API - Document
This service allows you to retrieve a list of KYC (documents) for a merchant or customer.
If you don't fill in Email, Id or ClientId, your own documents will be returned.

Request

Body Params application/x-www-form-urlencoded
Email
string 
optional
Easytransac merchant email address
<= 128 characters
Id
number 
optional
Easytransac merchant identifier
ClientId
string 
optional
Easytransac customer identifier
DocumentType
enum<string> 
optional
Document type, see Appendix
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
Status
enum<string> 
optional
Status of validation in compliance
Allowed values:
pendingvalidinvalid
Signature
string 
required
Signature to verify the integrity of the data sent

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.sandbox.easytransac.com/v2/api/kyc/find' \
--data-urlencode 'Signature='

Responses

🟢200Response
application/json
Body
Code
integer 
optional
Example:
0
Signature
string 
optional
Example:
1f51786246a940677afe71f6968972fd46500bd1
Result
array [object {6}] 
optional
Id
string 
optional
Example:
WEX35JSM9G
DocumentType
enum<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
enum<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"
    }
  ]
}
Previous
Get a document
Built with