Update a document

Create a document

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.

Path Parameters

Name	Type	Description
id	string	The ID of the document.

Headers

Name	Type	Description
Content-Type	string	The content-type must always be set to application/json.
Authorization	string	The API live or test key

Request Body

Name	Type	Description
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. national_identity_card 7. visa 8. polling_card 9. residence_permit 10. birth_certificate 11. bank_statement 12. change_of_name 13. tax_document 14. company_confirmation_statement 15. company_annual_accounts 16. company_statement_of_capital 17. company_change_of_address 18. company_incorporation 19. company_change_of_officers 20. company_change_of_beneficial_owners 21. unknown 22. 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
issuingCountry	string	The document's issuing country. This will be the two-letter country ISO code.

200 Document successfully created.

{
    "id": "5eb158880c19580007310f22",
    "clientId": "5eb1276d96be4a0008713af5",
    "type": "passport",
    "classification": "proof_of_identity",
    "issuingCountry": "GB",
    "createdAt": "2020-01-04T17:24:29.146Z",
    "updatedAt": "2020-01-04T17:13:10.712Z"
}

404 An example of a resource Not Found response, when an invalid document id is provided.

{
    "type": "resource_not_found",
    "message": "Invalid document id '5eb158880c19580007310f21'"
}

Example request

cURL

curl -X POST https://api.complycube.com/v1/documents/{:documentId} \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"type": "passport" 
        }'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const document = await complycube.document.update("DOCUMENT_ID", {
    type: "passport"
});

Python

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR API KEY>')

new_doc = cc_api.documents.update('DOCUMENT_ID',type='passport')

PHP

use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$doc = $ccapi->documents()->update('DOCUMENT_ID',['type' => 'driving_license']);