API Reference
Log inSign up
v1.7.3
v1.7.3
  • ComplyCube API Reference
  • Integration
  • Test 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
      • Delete image attachment
      • Download image attachment
      • Redact image attachment
      • Delete a document
      • List documents
      • Filtering documents
    • Live Photos
      • Upload a live photo
      • Get a live photo
      • Download live photo
      • Redact live photo
      • Delete a live photo
      • List live photos
    • Live Videos
      • Get a live video
      • Redact live video
      • Delete live video
      • List live videos
    • Checks
      • Create a check
      • Get a check
      • Update a check
      • Validate check outcome
      • Redact check outcome
      • List checks
      • Filtering checks
    • Risk Profile
      • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
    • Enhanced Identity Check
    • Proof of Address Check
    • Multi-Bureau Check
    • Face Authentication Check
    • Age Estimation Check
  • Lookups
    • Company Search
      • Search company
      • Get company details
    • Address Search
      • Search address
  • Tools
    • Custom Lists
      • Get a custom list
      • Add entity to custom list
      • List custom lists
  • Static Data
    • Screening Lists
    • Supported Documents
  • Other Resources
    • Flow (Hosted Solution)
      • Create a session
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • SDK Tokens
      • Generate a token
    • Autofill
      • Perform autofill
    • Reports
      • Generate a client report
      • Generate a check report
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
    • Account Info
      • Get account info
  • Useful Resources
    • Testing Data
    • User Docs
Powered by GitBook
On this page
  • URL
  • Headers
  • Path parameters
  • Body
  • Example request
  • Example responses

Was this helpful?

  1. Core resources
  2. Documents

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

Name
Type
Description

Content-Type*

string

The content-type must always be set to application/json.

Authorization*

string

The API live or test key.

Path parameters

Name
Type
Description

id*

string

The ID of the document.

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

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'
]);
using ComplyCube.Net;
using ComplyCube.Net.Resources.Documents;

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

var update = new DocumentRequest { type = "passport" };

var document = await docApi.UpdateAsync("DOCUMENT_ID", update);

Example responses

{
    "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"
}
{
    "type": "resource_not_found",
    "message": "Invalid document id '5eb158880c19580007310f21'"
}
PreviousGet a documentNextUpload image attachment

Last updated 1 year ago

Was this helpful?

The document's issuing country. This will be the .

two-letter country ISO code