Create a document

URL

POST https://api.complycube.com/v1/documents

Creates a new 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.

Body

Name

Type

Description

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

issuingCountry

string

The document's issuing country. This will be the two-letter country ISO code.

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" 
        }'

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

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

const document = await complycube.document.create("CLIENT_ID", {
    type: "driving_license",
    classification: "proof_of_identity",
    issuingCountry: "GB"
});

from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

new_document = {
    'type': 'driving_license',
    'classification': 'proof_of_identity',
    'issuingCountry': 'GB'
}

doc = cc_api.documents.create('CLIENT_ID', **new_document)

using ComplyCube.Net;
using ComplyCube.Net.Resources.Documents;

var docApi = new DocumentApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var docRequest = new DocumentRequest {
  clientId = "CLIENT_ID",
  type = "passport",
  classification = "proof_of_identity",
  issuingCountry = "GB"
};

var document = await docApi.CreateAsync(docRequest);

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"
}

{
    "type": "invalid_request",
    "message": "'classification' should be equal to one of the allowed values: proof_of_identity,source_of_wealth,source_of_funds,proof_of_address,company_filing,other",
    "param": "classification"
}

PreviousDocuments NextGet a document

Last updated 1 year ago

Was this helpful?