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
  • Environments
  • Sandbox
  • Live

Was this helpful?

Sandbox and Live

Learn about our sandbox and live integration environments.

PreviousIntegrationNextAuthentication

Last updated 4 years ago

Was this helpful?

Environments

To make our API as explorable as possible, accounts have test and live API keys. Just use the appropriate key to make API calls.

Requests made using a test API key will not incur a cost.

You can access your live and test API keys from your .

Sandbox

The ComplyCube Sandbox is a test environment that simulates the behaviour, responses, and errors of the live environment.

All conducted on the Sandbox will return dummy responses. Please refer to our page to learn about simulating specific test scenarios as part of your integration.

The ComplyCube Sandbox provides new users with a safe environment to conduct their testing and learn about our platform's various aspects. These include:

  • Network connectivity and authentication with the ComplyCube API.

  • Requests are being sent in the correct format.

  • Successful responses and are being handled appropriately.

  • Implement and test an appropriate mechanism for handing and errors.

  • Test out and .

  • Webhooks are working as expected.

Do not send any confidential or operational data when using the Sandbox.

Data in our sandbox environment is periodically deleted.

Live

Once you've performed integration and tested against the Sandbox, please get in touch, and we will switch you over to the Live environment.

Portal (Developers)
checks
Testing
errors
rate limits
service quota
pagination
filtering