The official Node.js library for integrating with the ComplyCube API.
ComplyCube enables you to automate your AML/KYC workflows effortlessly.
Documentation can be found at https://docs.complycube.com.
Using npm:
npm install @complycube/apiUsing Yarn:
yarn add @complycube/apiRequire the package:
const { ComplyCube } = require("@complycube/api");Configure with your API key:
const complycube = new ComplyCube({
apiKey: process.env.COMPLYCUBE_API_KEY
});Using with async/await (in an async function):
try {
const client = await complycube.client.create({
type: "person",
email: "[email protected]",
personDetails: {
firstName: "Jane",
lastName: "Doe"
}
});
const check = await complycube.check.create(client.id, {
type: "standard_screening_check"
});
return check;
} catch (error) {
if (error instanceof ComplyCubeApiError) {
// An error response was returned by the ComplyCube API.
console.log(error.message);
console.log(error.type);
} else {
console.log(error.message);
}
}Using with promises:
complycube.client
.create({
type: "person",
email: "[email protected]",
personDetails: {
firstName: "Jane",
lastName: "Doe"
}
})
.then(client =>
complycube.check.create(client.id, {
type: "standard_screening_check"
})
)
.then(check =>
// Handle successfully created check.
)
.catch(error => {
// Handle error.
});All responses will be JavaScript objects.
const client = await complycube.client.create({
type: "person",
email: "[email protected]",
personDetails: {
firstName: "Jane",
lastName: "Doe"
}
});
console.log(client);
{
"id": "<CLIENT_ID>",
"type": "person",
"email": "[email protected]",
"personDetails": {
"firstName": "Jane",
"lastName": "Doe"
},
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z"
}More documentation and code examples can be found at https://docs.complycube.com.
Further information on ComplyCube can be found at https://www.complycube.com.