API Reference
v1.7.3
Search
K

Add entity to custom list

post
https://api.complycube.com
/v1/customLists/:id/records
Add entity to custom list
Adds an entity (person or company) to the specified custom list.
Parameters
Path
id*
string
The ID of the custom list.
Header
Content-Type*
string
The content-type must always be set to application/json.
Authorization*
string
The API live or test key
Body
entityType*
string
The type of entity. Valid values are: 1. person 2. company
names*
array
An array of name objects that contain all known aliases for the entity. Also, see the names object below.
active
boolean
Indicates whether the entity is active or not.
gender
string
The gender. Only applicable when entity type is person. Valid values include: 1. male 2. female 3. other
countries
array
An array of value pair objects covering known associated countries for entity. Also, see the countries object below.
dates
array
An array of value pair objects covering important dates associated with the entity. Also, see the dates object below.
images
array
An array of strings that contain URIs of images for the entity.
Responses
200
Entity successfully added.

The name object

Attribute
Type
Description
firstName
string
The entity's first name. This is required when the entity type is person. (Optional)
middleName
string
The entity's middle name. (Optional)
lastName
string
The entity's last name. This is required when the entity type is person. (Optional)
companyName
string
The entity's company name. This is required when the entity type is company. (Optional)
type
string
The entity's name type. Valid values include:
  1. 1.
    primary
  2. 2.
    alias
  3. 3.
    maiden_name
  4. 4.
    localised_name
  5. 5.
    low_quality_alias
(Optional)

The countries object

Attribute
Type
Description
country
string
type
string
The entity's country type. Valid string values include:
  1. 1.
    "Jurisdiction"
  2. 2.
    ''Resident of''
  3. 3.
    "Citizenship"
  4. 4.
    "Country of Registration"
(Required)

The dates object

Attribute
Type
Description
date
object
The date in a structured format. The date object has the following attributes:
  1. 1.
    day: The day of the month. Value range "01" to "31", passed as string.
  2. 2.
    month: The month. Value range "1" to "12", passed as string.
  3. 3.
    year: The year, in YYYY format, passed as string.
(Required)
type
string
The entity's date type. Valid string values include:
  1. 1.
    "Date of Birth"
  2. 2.
    ''Date of Registration''
(Required)

Example request

cURL
curl -X POST https://api.complycube.com/v1/customLists/{:customListId}/records \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"entityType": "person",
"names": [
{
"type": "primary",
"firstName": "John",
"lastName": "Smith"
},
{
"type": "alias",
"firstName": "John",
"lastName": "Smyth"
}
],
"active": true,
"gender": "male",
"countries": [
{
"type": "Jurisdiction",
"country": "US"
},
{
"type": "Resident of",
"country": "GB"
}
],
"dates": [
{
"type": "Date of Birth",
"date": {
"day": "01",
"month": "01",
"year": "1987"
}
}
],
"images": [
"https://www.example.com/johnDoe.jpg"
]
}'