When you create or edit an entity, the fields below are either optional or required.

general_data

Fields

Definition

Example

entity_id

The unique identifier for an entity, as defined in your system

  • 1a2b3c4d5e
  • Corp-356-agh

entity_type

The type of user in your system. Must be either user or business

  • user
  • business

entity_subtype

Extra information about how your organization classifies the entity. You MAY enter any value

  • contractor

status

Status of the object on your system. You MAY enter any string value.

  • active
  • registered

registered_at

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time).

  • 1623365011

parents[].parent_entity_id

The unique identifier for an entity, which is the parent of the this entity in your system, as defined by you

  • userB-02cc742
  • CorpXYZ

parents[].parent_entity_type

The type of user the parent is within your system. Must be either user or business

  • user
  • business

tags

Additional information that can be used for grouping and filtering in "key:value" format

  • sector:Europe
  • source:UK_internal

user_data (required if "entity_type='User")

Fields

Definition

Example

first_name

First name of the user

  • John

middle_name

Middle name of the user

  • Matt

last_name

Last name of the user

  • Smith

day_of_birth

Date of birth of the user

  • 23

month_of_birth

Month of birth of the user

  • 12

year_of_birth

Year of birth of the user

  • 1990

gender

Gender of the user

  • Male
  • Female
  • Other

ssn

Social security number of "User", in the format of "xxx-xx-xxxx"

  • 123-45-6789

business_data (required if entity_type="Business")

Fields

Definition

Example

business_name

The registered name of the business

  • Acme

corporate_tax_id

The TIN/EIN of the business

  • 11-222-3333

account_holder_name

The name of the main person associated with the business

  • John Smith

registered_state

State or region where the business is registered. For the U.S., use the two character state code. For non-U.S., use the ISO 3166-2 standard

  • NY

registered_country

Country where the business is registered - use the ISO 3166-1 standard

  • US

doing_business_as

Operating name of business

  • Global Liquids

document_data

Fields

Definition

Example

document_id

The ID or number of the document

  • G3352403F

document_type

The type of document. Supported SARS types are: "drivers_license", "passport", "other", "alien_registration"

  • drivers_license

state

For the U.S., use the two character state code. For non-U.S., use the ISO 3166-2 standard

  • NY

country

Use the ISO 3166-1 standard

  • US

issued_at

Date when document was created, in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572673226

expires_at

Date when document expires, in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572673226

communication_data

Fields

Definition

Example

email_addresses

List of Email addresses associated with the entity

phone_numbers

List of phone numbers associated with the entity, in E.164 format.

  • ["+14159627132"]

location_data

Fields

Definition

Example

type

A field indicating the type of location

  • Shipping

building_number

Building number of the location

  • 66

unit_number

Flat/apartment/suite number of the building

  • 22A

street_name

Street name of the location

  • California Ave

city

City of the location

  • Redmond

state

State or region for the location. For the U.S., use the two character state code. For non-U.S., use the ISO 3166-2 standard

  • CA

postal_code

Postal code of the location

  • 07710-0001

country

Country of the location - use the ISO 3166-1 standard

  • US

digital_data.ip_address

Fields

Definition

Example

ip_address

List of IP addresses. MUST be in either IPv4 or IPv6 format. Used for geolocating.

  • 52.15.247.208

first_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572673225

last_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572673225

digital_data.client_fingerprint

Fields

Definition

Example

fingerprint

Fingerprints associated with this entity

  • 4908h2nj3k2kj2jk23kj2

first_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572643226

last_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572673229

instrument_ids

Fields

Definition

Example

instrument_ids

Instrument id associated with this entity

  • [123456789]

custom_data

Fields

Definition

Example

custom_data

Any additional information that should be associated with this entity in "key:value" format (freeform JSON)

  • Approved by: John Doe

Did this page help you?