Update a document
URL
POST https://api.complycube.com/v1/documents/:id
Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Headers
Content-Type*
string
The content-type must always be set to application/json.
Authorization*
string
The API live or test key.
Path parameters
id*
string
The ID of the document.
Body
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
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
Example request
curl -X POST https://api.complycube.com/v1/documents/{:documentId} \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"type": "passport"
}'const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const document = await complycube.document.update("DOCUMENT_ID", {
type: "passport"
});from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
document = cc_api.documents.update('DOCUMENT_ID', type='passport')use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$document = $ccapi->documents()->update('DOCUMENT_ID', [
'type' => 'passport'
]);