Tx Verify API Reference

Introduction to our API Reference.

Tx Verify is a turnkey cloud and API platform for automating Identity Verification (ID&V), Anti-Money Laundering (AML), and Know Your Customer (KYC) compliance workflows.

The ComplyCube API follows REST principles - it has predictable, resource-oriented URLs and uses HTTP response codes. All API responses, including errors, return JSON.

We’ve designed our documentation to be easy to follow. It is grouped by resource type and offers practical examples.

As a general guideline, if a property has an empty or null value, we drop it from the JSON unless there’s a strong semantic reason for its existence.

If you're just getting started, we recommend checking out our user guide first.

Integration

REST API

All our services are available through our RESTful API, which works with any language that supports HTTP/cURL, such as Java, Ruby, .NET, Node, PHP, Python, JavaScript, and much more.

Additionally, it can be invoked through any third-party platform that can make HTTP requests, including WordPress.

You may also use the Tx Verify OpenApi specification to automatically generate code in almost any language, using free or paid tools such as OpenAPI Generator.

See how you can integrate with the Tx Verify API Reference.

Web SDK

Tx Verify API Reference officially maintains and supports a fully customizable Web SDK for Frontend JavaScript.

Mobile SDK

For a mobile-native experience, Tx Verify API Reference provides iOS, Android, React Native, Flutter, and Cordova SDKs.

Hosted Solution

Tx Verify API Reference Flow is a secure, branded, fully customizable, hosted KYC and identity verification page that lets you verify your clients quickly, with minimal code. It leverages URL redirects, works across devices, and is designed to maximize conversions.

Client Libraries

Tx Verify API Reference provides Node.js, PHP, .NET, and Python client libraries for back-end applications for seamless integration with your ecosystem.

# Install using npm

npm install --save @complycube/api

# Install using Yarn

yarn add @complycube/api

Postman

If you're looking to get quickly familiar with our API or test it out, we recommend leveraging the Tx Verify API Reference Postman collection.

OpenAPI Specification

Tx Verify API Reference maintains OpenAPI (v3) specifications for the latest API version

79 kb

TxVerifyAPIReference-openapi.yaml

Tx Verify API Reference OpenAPI v3 Specification

Clients

Clients are a core resource to all Tx Verify services.

A client represents the person or company you will perform on the various checks. To initiate a check, you must first create a client.

The API allows you to create, retrieve, update, and delete your clients. You can retrieve specific clients as well as a list of all your clients.

The Client object

Attribute

Type

Description

id

string

The unique identifier for a client.

Type

string

The type of client. Valid values are:

person

company

entityName

string

The client's full name.

email

string

The client's email address.

mobile

string

The client's mobile number.

telephone

string

The client's telephone number.

externalId

string

A unique identifier that you can associate with the client. For example, this can be the client ID in your system.

joinedDate

string

The date and time when you registered the client. This is relevant for users that migrate existing clients. The format is YYYY-MM-DD.

personDetails

object

Details for a client of type person. Also, see the personDetails object below.

companyDetails

object

Details for a client of type company. Also, see the companyDetails object below.

metadata

object

Set of key-value pairs that you can associate with the client object. This is useful for storing additional information about the client in a structured format. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.

createdAt

string

The date and time when the client was created.

updatedAt

string

The date and time when the client was updated.

The personDetails object

Attribute

Type

Description

firstName

string

The client's first name.

(Required)

middleName

string

The client's middle name.

(Optional)

lastName

Type

Description

id

string

The unique identifier for a client.

Type

string

The unique identifier for a client.