API Reference
Log inSign up
v.1.7.2
v.1.7.2
  • Introduction
  • Integration
  • Sandbox and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
  • Clients
    • Create a client
    • Get a client
    • Update a client
    • Delete a client
    • List clients
    • Filtering clients
  • Addresses
    • Create an address
    • Get an address
    • Update an address
    • Delete an address
    • List addresses
    • Filtering addresses
  • Documents
    • Create a document
    • Get a document
    • Update a document
    • Upload image attachment
    • Download image attachment
    • Delete image attachment
    • Delete a document
    • List documents
    • Filtering documents
  • Live Photos
    • Upload a live photo
    • Get a live photo
    • Download live photo
    • Delete a live photo
    • List live photos
  • Checks
    • Create a check
    • Get a check
    • Update a check
    • Validate check outcome
    • List checks
    • Filtering checks
  • Risk Profile
    • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
  • Other Resources
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • Reports
      • Generate a client report
      • Generate a check report
    • SDK Tokens
      • Generate a token
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
Powered by GitBook
On this page
  • Create a document
  • Example request

Was this helpful?

  1. Documents

Create a document

Create a document

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

Request 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. 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.

{
    "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"
}
{
    "type": "resource_not_found",
    "message": "Invalid client id '5eb1276d96be4a0008713af2'"
}

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

cc_api = complycube.addresses.create('CLIENT_ID',**new_document)
use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR API KEY>');
$doc = $ccapi->documents()->create('CLIENT_ID',['type' => 'passport']);
PreviousDocumentsNextGet a document

Last updated 4 years ago

Was this helpful?