Create a document
URL
POST https://api.complycube.com/v1/documents
Creates a new document.
Headers
Content-Type
*
string
The content-type must always be set to application/json
.
Authorization
*
string
The API live
or test
key.
Body
clientId
*
string
The ID of the client associated with this document.
type
*
string
The type of document. Valid values include:
1. passport
2. driving_license
3. national_insurance_number
4. social_security_number
5. tax_identification_number
6. utility_bill
7. national_identity_card
8. visa
9. polling_card
10. residence_permit
11. birth_certificate
12. bank_statement
13. change_of_name
14. tax_document
15. company_confirmation_statement
16. company_annual_accounts
17. company_statement_of_capital
18. company_change_of_address
19. company_incorporation
20. company_change_of_officers
21. company_change_of_beneficial_owners
22. unknown
23. other
documentNumber
string
The document's number.
classification
string
The classification or purpose of this document. Valid values include:
1. proof_of_identity
2. source_of_wealth
3. source_of_funds
4. proof_of_address
5. company_filing
6. other
issuingState
string
The state that issued the document. This must be the state's USPS abbreviation (e.g. NY
, CA
, or DE
).
Example request
curl -X POST https://api.complycube.com/v1/documents \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"clientId":"5eb1276d96be4a0008713af5",
"type": "driving_license",
"classification": "proof_of_identity",
"issuingCountry": "GB"
}'
Example responses
{
"id": "5eb158880c19580007310f22",
"clientId": "5eb1276d96be4a0008713af5",
"type": "driving_license",
"classification": "proof_of_identity",
"issuingCountry": "GB",
"createdAt": "2020-01-04T17:24:29.146Z",
"updatedAt": "2020-01-04T17:24:29.146Z"
}
Last updated
Was this helpful?