Data Structures | Parallel Developer Documentation

Skip to main content

Version: Current – v2.x

On this page

These are the JSON structures that are returned as API responses.

General ​

Location ​

A particular place in the world.

Name Type Description
address_one string Street address
address_two string Second address line (apartment, suite, block, etc)
city string Name of city
region string Region is available for non-US addresses
postal_code string A postal code (this will be a zip code for a US-based address)
state string State for US-based addresses
country string Two-letter ISO Alpha-2 Country Code country code

Example ​

{

"address_one": "123 Fake St",

"address_two": "Apt 3",

"city": "New York",

"region": null,

"postal_code": "10011",

"state": "NY",

"country": "US"

}

User Session ​

Metadata about a web session that interacted with parallelmarkets.com

Name Type Description
maybe_anonymizing_proxy boolean true if the user did use an anonymizing proxy (e.g. TOR, Public VPN) when submitting linked information.
country_code string An alpha-2 ISO 3166 string indicating the country in which the user appeared to be when submitting linked information. Null if unknown.
region string A string listing the name of the state or region in which the user appeared to be when submitting linked information. Null if unknown.
city string A string listing the name of the city in which the user appeared to be when submitting linked information. Null if unknown.

Example ​

{

"maybe_anonymizing_proxy": false,

"country_code": "US",

"region": "North Carolina",

"city": "Durham"

}

Dates and Timestamps ​

All date and date time (aka, timestamp) information is provided in standard ISO-8601 format. Dates will be provided as YYYY-MM-DD strings (i.e., "2021-06-10"). Timestamps will be provided as string UTC dates with time in the format YYYY-MM-DDThh:mm:ssZ (i.e., "2021-06-29T13:32:21Z").

Case Management ​

Record ​

An individual or business linked to your case management instance.

Name Type Description
id string Unique ID of the record. This can be used to uniquely identify a particular record when calling the API endpoints, or can be used to navigate to the record details page on the dashboard for this particular record.
For dashboard navigation, the following URL can be used to redirect to the record details page if the current user is authorized to view the record: https://app.parallelmarkets.com/id/{id}
type string The type of record. Can be individual or business.
details object A Business Record Details or Individual Record Details object depending on the type. This attribute is not returned by any list endpoints, it is only returned by endpoints that return a single business or individual record.
traits object[] An array of configured record traits with values (if there are any).
identity_link_established_at string Timestamp of when the entity granted permissions to share their data.
identity_link_expires_at string Timestamp of when the identity link will expire and updates to data will cease to be shared with the partner.
identity_link_expiration_requested_by string Who requested the data link to be revoked. Can be one of:
- subject - Access revocation requested by the subject of the record.
- partner - Access revocation requested by the partner.
- null - Access revocation has not been requested.
- system - Access to this subject's data was revoked by our internal systems.
current_status object An Record Status object.
created_at string Timestamp of when the record was created.
archived_at string Timestamp of when the record was archived.
ref_code string The ref_code value provided when initiating the Parallel flow via the SDK or by providing a ref_code query string parameter to your Bridge Page URL. Will be null if no ref_code was provided. This value can only be set once based on the value in the first handoff.
external_id string A custom unique identifier for this record. See Using an External Identifier for more information.
risk_monitoring_status string The subject's current risk monitoring status. This attribute is not returned by any list endpoints, it is only returned by endpoints that return a single business or individual record.
possible_or_likely_risk_match_count number The number of risk matches that were resolved as possible-match or likely-match if risk_monitoring_status is enabled, null otherwise. This attribute is not returned by any list endpoints, it is only returned by endpoints that return a single business or individual record.
potential_risk_match_count number The number of unresolved risk matches if risk_monitoring_status is enabled, null otherwise. This attribute is not returned by any list endpoints, it is only returned by endpoints that return a single business or individual record.
subject_last_submitted_identity_at string Timestamp of when the subject associated with the record most recently submitted their identity details. The value is null when the subject has never submitted their identity details.

Risk monitoring statuses:

Example ​

{

"created_at": "2022-08-29T15:14:44Z",

"current_status": {

"notes": "This is a test note.",

"set_at": "2023-05-17T15:14:44Z",

"set_by": {

"email": "joe@acme.com",

"first_name": "Joe",

"last_name": "Bloggs"

},

"status": "approved"

},

"id": "UG9kVXNlclJlY29yZDoyNDQw",

"identity_link_established_at": "2022-08-29T15:14:44Z",

"identity_link_expiration_requested_by": null,

"identity_link_expires_at": null,

"type": "individual",

"external_id": "unique_external_id_123",

"user_deactivated_at": null,

"user_requested_deletion_at": null

}

Record Comment ​

A comment for an individual or business entity record.

Name Type Description
text string The text of the comment.
created_at string Timestamp of when the comment was added.
created_by object An Individual Profile object containing information about the partner team member that added the comment; null if the comment is created via the API.
source string The source that set the status. Can be one of:
- api
- user

Example ​

{

"text": "This is a test comment.",

"created_at": "2023-05-17T15:14:44Z",

"created_by": {

"email": "joe@acme.com",

"first_name": "Joe",

"last_name": "Bloggs"

},

"source": "user"

}

Record Status ​

The current status of an individual or business entity.

Name Type Description
status string The current status of the entity. Can be one of:
- open
- pending
- approved
- declined
set_at string Timestamp of when the current status was set.
set_by object An Individual Profile object containing information about the partner team member that set the status.
source string The source that set the status. Can be one of:
- api
- system
- user
notes string Notes created for the entity by a partner team member.

Example ​

{

"notes": "This is a test note.",

"set_at": "2023-05-17T15:14:44Z",

"set_by": {

"email": "joe@acme.com",

"first_name": "Joe",

"last_name": "Bloggs"

},

"status": "approved",

"source": "user"

}

Risk Match ​

A risk match for an individual or business.

Name Type Description
id string Identifier for the specific risk match.
change_id string Identifier for the specific record change entry that this risk match is associated with.
created_at string Timestamp of when the risk match was created.
match_details object An Individual Risk Monitor Match or Business Risk Monitor Match object.
review_details object A Risk Match Review Details object. This attribute is not returned by all endpoints. It is only returned by the endpoint to retrieve a single business or individual risk match.
resolution_id string The identifier of the current resolution applied to the risk match.
resolution string The current resolution status applied to the risk match by a partner team member. Can be one of:
- name-mismatch
- nationality-mismatch
- birth-date-mismatch
- sex-mismatch
- facial-mismatch
- possible-match
- likely-match
resolution_notes string Notes provided by a partner team member when resolving the risk match.
resolved_at string Timestamp when the resolution was applied to the risk match by a partner team member.
resolved_by object An Individual Profile object of the partner team member that applied the resolution.
source string The source that applied the resolution. Can be one of:
- api
- system
- user

Example ​

{

"change_id": "UG9kVXNlckRhdGFFbnRyeTo5NTA=",

"created_at": "2023-06-07T09:54:33Z",

"id": "VXNlclJpc2tNb25pdG9yTWF0Y2g6NDU=",

"match_details": {

"adverse_media": true,

"birth_date": "1957-03-10",

"currently_sanctioned": true,

"deceased": true,

"disqualified_director": false,

"financial_regulator": true,

"first_name": "Joe",

"insolvent": false,

"last_name": "Sanctioned",

"law_enforcement": true,

"middle_name": "PATRICK",

"nationalities": ["RU"],

"pep": true,

"previously_sanctioned": false,

"score": 100

},

"review_details": {

"aliases": [\
\
      {\
\
        "first_name": "Joseph",\
\
        "middle_name": "Patrick",\
\
        "last_name": "Sanctioned"\
\
      }\
\
    ],

"notes": [\
\
      "Listed as a sanctioned individual by the United States Office of Foreign Assets Control (OFAC)"\
\
    ],

"image_url": "https://ari-cdn.parallelmarkets.com/cdn/content/123.PNG",

"articles": [\
\
      {\
\
        "original_url": "https://example.com/123",\
\
        "archival_url": "https://example.com/123.pdf",\
\
        "date_collected": "2022-06-13",\
\
        "categories": ["Sanction (current)", "Insolvent"]\
\
      }\
\
    ],

"current_sanctions": ["Office of Foreign Assets Control (OFAC)"],

"former_sanctions": ["Japan Ministry of Finance"],

"pep_tier": "PEP Tier 2",

"addresses": [\
\
      {\
\
        "address_one": "11 11th st",\
\
        "address_two": "11L",\
\
        "city": "Brooklyn",\
\
        "country": "US",\
\
        "postal_code": "11201",\
\
        "region": null,\
\
        "state": "NY"\
\
      }\
\
    ]

},

"resolution": "likely-match",

"resolution_id": "UG9kVXNlclJpc2tNYXRjaDoxMTU=",

"resolution_notes": "Name, DOB, Nationality and picture indicate a likely match.",

"resolved_at": "2023-06-07T09:54:33Z",

"resolved_by": {

"email": "reviewer@acme.com",

"first_name": "John",

"last_name": "Reviewer"

},

"source": "user"

}

Risk Match Review Details ​

Information about a sanctioned (or otherwise risky) entity for review when determining the resolution of a potential match to an individual or business.

Name Type Description
addresses object[] An array of Location objects for associated addresses.
articles object[] An array of Risk Match Review Article objects.
aliases object[] An array of objects containing alias information for the entity.
For individuals the object contains:
- first_name
- middle_name
- last_name
For businesses the object contains:
- name
image_url string URL for the profile image of the entity, if one is available.
notes string[] An array of notes on the entity.
current_sanctions string[] An array of sanctioning bodies for the entity's current sanctions.
former_sanctions string[] An array of sanctioning bodies for the entity's former sanctions.
pep_tier string String indicating the entity's PEP tier. Only applicable for individuals who are considered a Politically Exposed Person.

Example ​

{

"aliases": [\
\
    {\
\
      "first_name": "Joseph",\
\
      "middle_name": "Patrick",\
\
      "last_name": "Sanctioned"\
\
    }\
\
  ],

"notes": [\
\
    "Listed as a sanctioned individual by the United States Office of Foreign Assets Control (OFAC)"\
\
  ],

"image_url": "https://ari-cdn.parallelmarkets.com/cdn/content/123.PNG",

"current_sanctions": ["Office of Foreign Assets Control (OFAC)"],

"former_sanctions": ["Japan Ministry of Finance"],

"pep_tier": "PEP Tier 2",

}

Risk Match Review Article ​

Published information about a sanctioned (or otherwise risky) entity.

Name Type Description
categories string[] An array of categorical tags applicable to the article. For example:
- Sanction (current)
- Adverse Media
- Disqualified Director
date_collected string Date of when the article was initially collected for review.
original_url string URL for the article referencing the entity.
archival_url string URL for the PDF version of the article, if available.

Individual Record Details ​

A record for an individual in the Case Management system.

Name Type Description
birth_date string Date representing the individual's date of birth.
birth_place string The individual's place of birth.
citizenship_country string ISO Alpha-2 Country Code; The individual's country of citizenship.
secondary_citizenship_countries string[] An array of two-letter ISO Alpha-2 Country Code country codes representing the individuals secondary countries of citizenship.
domicile_location object A Location for the individual's legal address, where they pay taxes.
email string The individual's email address.
first_name string The individual's provided legal first name.
middle_name string The individual's provided legal middle name (if any).
last_name string The individual's provided legal last name.
name_suffix string The individual's name suffix (e.g., "Jr.", "Sr.", "III").
gender string The individual's gender. Can be one of:
- male
- female
- other
marital_status string single, married, separated or divorced; The individual's marital status (if any).
phone string The individual's provided phone number. Will be provided in standard E.164 format with a country code prefix (i.e., "+12121234567").
residence_location object A Location where the individual maintains a part or full-time residence.
tax_id string The individual's tax id number.
tax_country string The individual's tax country.
secondary_tax_id object[] An array of Secondary Tax ID object.
us_person boolean Indicates whether the individual is a U.S. person for federal tax purposes (includes but not limited to an individual U.S. citizen or U.S. resident alien). Null if unknown.
user_session object A User Session containing details about the session that provided this information.
change_created_at string Timestamp of when the change was made.
change_created_by object An Individual Profile object of the individual who created the change.
change_id string Identifier for the specific change entry. As individual records within Parallel Markets can change over time, this identifier can be used to obtain a snapshot of data associated with this identifier.
source string The source of the change. Can be one of:
- api
- system
- user
consistency_summary object The Individual Consistency Summary results.
indicated_unaccredited_at string Timestamp indicating when the individual was marked unaccredited.
accreditation_expires_at string Timestamp at which the individual's accreditation expires.
id_expiration string The expiration date of the individual's ID.
accreditation_assertion_type string The assertion type used to determine the individuals accreditation status. A list of assertion types is provided below.
accreditation_status string The individual's accreditation status. This will be one of "CURRENT", "EXPIRED", or null. See the Accreditations API for the status of accreditation applications.
risk_monitoring_status string The individual's risk monitoring status for the specific change entry.
user_deactivated_at string Timestamp when the user associated with the record was deactivated. A user can be deactivated if they submit a data deletion request, or, in rare cases, if they have violated Parallel's Terms of Service.
user_requested_deletion_at string Timestamp when the user associated with the record requested that Parallel stop sharing data updates with partners' Case Management systems. Copies of the individual's data that exist within partner owned Case Management areas on Parallel's systems won't be affected. See the support article for data deletion requests for more information.

Assertion types:

Risk monitoring statuses:

Business Record Details ​

A record for a business in the Case Management system.

Name Type Description
name string The business's provided legal name.
business_type object See Business Profile for possible values.
control_persons object[] An array of Control Person objects.
beneficial_owners object[] An array of Beneficial Owner objects.
incorporation_country string Two-letter ISO Alpha-2 Country Code representing the business's country of incorporation.
incorporation_region string The business's region of incorporation, if applicable null if incorporated in the United States.
incorporation_state string Two-letter state code; The business's state of incorporation. null unless incorporated in the United States.
primary_contact object An Individual Profile for the primary contact for the business.
principal_location object A Location representing where the business primarily conducts its business.
domicile_location object A Location representing the business's legal domicile.
accreditation_assertion_type string The assertion type used to determine the business's accreditation status. A list of assertion types is provided below.
accreditation_status string The business' accreditation status. This will be one of "CURRENT", "EXPIRED", or null. See the Accreditations API for the status of accreditation applications.
indicated_unaccredited_at string The timestamp indicating when the business was marked unaccredited.
accreditation_expires_at string The timestamp at which the business's accreditation expires.
beneficial_ownership_threshold number The threshold used to determine beneficial ownership. Default value: 0.25 (25%).
consistency_summary object The Business Consistency Summary results.
change_created_at string A timestamp of when the change was made.
change_created_by object An Individual Profile object of the individual who created the change.
change_id string Identifier for the specific change entry. As business records within Parallel Markets can change over time, this identifier can be used to obtain a snapshot of data associated with this identifier.
source string The source of the change. Can be one of:
- api
- system
- user
tax_id string The business's provided tax id number (e.g. EIN).
tax_country string The business's tax country.
secondary_tax_id object[] An array of Secondary Tax ID object.
us_person boolean Indicates whether the business is a U.S. person for federal tax purposes (includes but is not limited to a partnership, corporation, company or association created or organized in the United States or under the laws of the United States; any estate (other than a foreign estate); or a domestic trust). Null if unknown.
risk_monitoring_status string The business's risk monitoring status for the specific change entry.

Assertion types:

Risk monitoring statuses:

Record File ​

A file associated with a Case Management record.

Name Type Description
name string The file name (e.g., "document.pdf") provided when the file was uploaded.
type string A "kebab-case" string representing the id of the Record File Type. This has no bearing on the Content-Type of the file.
type_name string A "Title Case" string representing the name of the Record File Type. If type is "other", then type_name will either be "Other" or a custom value for this file.
category string One of "accreditation-document", "identity-document" or "general-document" based on the type of the file.
download_url string URL where the document is available. The URL includes a token that enables embedding of the document in a webpage (or a direct download with a GET request).
download_url_expires number Number of seconds until the token in the download_url expires.
change_id string Identifier for the specific change entry the file is associated with, if any. As individual or business records within Parallel Markets can change over time, this identifier can be used to obtain a snapshot of data associated with this identifier.
expires_at string Timestamp representing when the document expires, if known.
source string The source of the file. Can be one of:
- api
- system
- user
created_at string Timestamp of when the file was added to the Case Management record.
consistency_details object Consistency details for the file. This attribute is only available for files returned as part of an individual consistency summary.

Record File Type ​

An enumerated type used for Record File document classification.

Name Type Description
id string A unique "kebab-case" string representing the document type, suitable for use as an identifier or key.
name string A "Title Cased" string representing the document type, suitable for display to end-users.
category string One of "accreditation-document", "identity-document" or "general-document".
description string A description of the document type.

Secondary Tax ID ​

A secondary tax identification number for an individual or business.

Name Type Description
tax_id string The secondary tax identification number for the individual or business.
tax_country string A two-letter ISO Alpha-2 Country Code country code representing the country associated with the individual's or business's secondary tax identification number.

Record Trait ​

Record traits allow you, as a partner, to store custom attributes about an individual or business. You can read more about configuring record traits on the partner support page.

Name Type Description
id string A unique "kebab-case" string representing the configured record trait.
name string A string, representing the name of the configured trait.
type string A string, representing the type of the configured trait. One of:
- boolean
- date (the value is served as string)
- number (the value is served as string)
- string
- strings (corresponds to the multi-string type in the record trait configuration UI).
value Varies based on type, one of:
- boolean
- string
- string[]		 Value of the configured trait for the given individual or business. If no value, then can be an empty array ([]) for multi-string (strings) type or null for all other types.

note

We do not currently support programmatically configuring traits via the API. Traits can be configured in your partner dashboard.

Accreditation Reviewer Note ​

An object representing a current reviewer note for a given accreditation.

Name Type Description
text string Content of the note
created_at string Timestamp of when the note was created

Example ​

{

"text": "Waiting for additional documentation from subject.",

"created_at": "2023-09-01T16:00:00Z"

}

Individual Data Structures ​

Individual Profile ​

An individual person's profile details.

Name Type Description
email string Person's email address (may be null based on permissions)
first_name string First name of person
last_name string Last name of person

note

Note that the name used here is the current one the person has set in their profile settings, which may not be the same as their legal names used in accreditation or identity flows (the legal names in an Individual Accreditation or Individual Identity Details response may be different).

Example ​

{

"email": "test@example.com",

"first_name": "Wyman",

"last_name": "Manderly"

}

Individual Accreditation ​

An object representing an accreditation application by an individual.

Name Type Description
id string Unique identifier for the accreditation
status string One of the statuses listed below
assertion_type string One of the types listed below
created_at ( Deprecated) string Timestamp of when the accreditation application was submitted by the user. Note that created_at will be null if the user began but never finished their application.
submitted_at string Timestamp of when the accreditation application was submitted by the user. Note that submitted_at will be null if the user began but never finished their application.
started_at string Timestamp of when the accreditation application was started by the user.
certified_at string Timestamp of when the accreditation application was certified and accreditation certification letter was issued
expires_at string Timestamp of when the accreditation certification letter expires
rejected_at string Timestamp of when the accreditation application was rejected
cancled_at string Timestamp of when the accreditation application was canceled
first_name string The first name of the individual
last_name string The last name of the individual
documents object[] A list of Accreditation Document Record Files
rejection_reason string One of the reasons listed below (if the accreditation is rejected)
change_ids string Identifiers for the specific change entries associated with the accreditation.
reviewer_note object An Accreditation Reviewer Note regarding the accreditation.

Accreditation application statuses:

Assertion types:

Accreditation application rejection reasons:

note

Note that the first and last name given here may not match the name in the user's current Individual Record Details. The name given in the accreditation assertion is the name used at the time of accreditation, and the accreditation is only valid for the individual named. The name returned in the user's current Individual Record Details may have changed since the time of the accreditation.

Example ​

{

"assertion_type": "income",

"change_ids": ["UG9kVXNlckRhdGFFbnRyeTo5NTA="],

"created_at": "2023-09-01T12:00:00Z",

"submitted_at": "2023-09-01T12:00:00Z",

"started_at": "2023-09-01T16:00:00Z",

"certified_at": "2023-09-01T16:00:00Z",

"expires_at": "2023-11-01T16:00:00Z",

"rejected_at": null,

"canceled_at": null,

"id": "VXNlckFjY3JlZGl0YXRpb246MQ==",

"status": "current",

"first_name": "Snake",

"last_name": "Plissken",

"documents": [\
\
    {\
\
      "download_url": "https://api.parallelmarkets.com/files/123?token=abc123",\
\
      "download_url_expires": 30,\
\
      "type": "certification-letter"\
\
    }\
\
  ],

"reviewer_note": {

"text": "Waiting for additional documentation from subject.",

"created_at": "2023-09-01T16:00:00Z"

}

}

Individual Consistency Summary ​

An object representing the consistency summary results for an individual.

Name Type Description
address_id_match boolean true if we were able to detect an address on the individual's identity document (for example, a driver license) and it matches a submitted domicile or residence location; false if the identity document address does not match either the domicile or residence location; null if we were unable to detect an address on the individual's identity document or if an identity document was not submitted
address_id_value string The address we were able to detect on the individual's identity document; null if we were unable to detect an address on the submitted identity document or if an identity document was not submitted
address_records_match_level string One of the consistency levels (see below) for the submitted domicile and residence locations
address_submitter_match boolean true if the submitter's location (detected from their IP address) matched either the domicile or residence location, false otherwise
birth_date_id_match boolean true if the individual's submitted date of birth matches the date of birth listed on the individual's submitted identity document (for example, a passport); false if the date of birth does not match; null if we were unable to detect a date of birth on the submitted identity document or if an identity document was not submitted
birth_date_id_value string Date representing the submitted individual's date of birth detected on the individual's identity document; null if we were unable to detect a date of birth on the submitted identity document or if an identity document was not submitted
birth_date_records_match_level string One of the consistency levels (see below) for the submitted individual's date of birth; null if an identity document was not submitted
id_selfie_similarity_level string One of the consistency levels (see below) representing the probability that the selfie photo and the photo on the Government ID are of the same person; null if selfie photo and/or Government ID were not collected or if we were unable to detect a face on the selfie photo
id_validity string One of the submitted identity document validity results (see below); null if an identity document was not submitted
id_matching_sides boolean true if there is more than one image from a government ID (say, front/back of a driver's license) and they all appear to be from the same ID; false if there is more than one image and discrepancies were found; null if there was only one side uploaded (for example, a passport)
id_files object[] A list of identity documents used to determine the Government ID and selfie photo consistency summary results
name_id_match boolean true if we were able to detect the individual's name on their identity document (for example, a passport) and it matches the submitted name; false if the identity document name does not match the submitted name; null if we were unable to detect a name on the submitted identity document or if an identity document was not submitted
name_id_value string The submitted individual's name detected on the individual's identity document; null if we were unable to detect a name on the submitted identity document or if an identity document was not submitted
name_records_match_level string One of the consistency levels (see below) for the submitted individual's name
name_tax_match boolean true if the submitted individual's name matches the name listed in a tax form (if it was submitted), false otherwise
name_tax_value string The submitted individual's name (from a tax form if it was submitted)
overall_records_match_level string One of the consistency levels (see below) representing overall consistency between submitted identity details and records search results
possibly_deceased boolean true if the records search results indicated that the submitted individual is possibly deceased
selfie_liveness_probability_level string One of the consistency levels (see below) representing the probability that the individual in the selfie photo was captured live on camera; null if selfie photo and/or Government ID were not collected or if we were unable to detect a face on the selfie photo
tin_multiple_match boolean true if the records search matched multiple entities with the submitted US or foreign tax id number, false otherwise
tin_records_match_level string One of the consistency levels (see below) for the submitted US or foreign tax id number

Consistency levels:

Identity document validity results:

Example ​

{

"address_id_match": true,

"address_id_value": "123 Fake St, New York, NY, 10011, US",

"address_records_match_level": "high",

"address_submitter_match": true,

"birth_date_id_match": true,

"birth_date_id_value": "1969-12-31",

"birth_date_records_match_level": "high",

"id_validity": "valid",

"id_matching_sides": true,

"id_selfie_similarity_level": null,

"name_id_match": true,

"name_id_value": "Jonathan O'Neill",

"name_records_match_level": "medium",

"name_tax_match": true,

"name_tax_value": "Jonathan O'Neill",

"overall_records_match_level": "high",

"possibly_deceased": false,

"selfie_liveness_probability_level": null,

"tin_multiple_match": false,

"tin_records_match_level": "high"

}

Individual Identity Document Consistency Details ​

An object representing the consistency detail results for an individual's identity document.

Identity document validity results:

Example ​

{

"address_id_match": true,

"address_id_value": "123 Fake St, New York, NY, 10011, US",

"birth_date_id_match": true,

"birth_date_id_value": "1969-12-31",

"id_country": "US",

"id_expiration": "2029-12-31",

"id_number": "111222333",

"id_selfie_similarity_level": null,

"id_side": "front",

"id_validity": "valid",

"name_id_match": true,

"name_id_value": "Jonathan O'Neill",

"selfie_liveness_probability_level": null

}

Individual Risk Monitor Match ​

Information about a potential match between an individual and a sanctioned (or otherwise risky) entity.

Name Type Description
adverse_media boolean true if the matched individual appears in searched media sources linking them to serious crime (e.g. fraud, money laundering, terrorism, etc.)
birth_date string Date representing the matched individual's date of birth
currently_sanctioned boolean true if the matched individual appears in any monitored sanctions datasets
deceased boolean true if the matched individual is deceased
disqualified_director boolean true if the matched individual appears in any searched disqualified director datasets
financial_regulator boolean true if the matched individual appears in any searched financial regulator datasets
insolvent boolean true if the matched individual appears in any insolvency datasets
first_name boolean The first or given name of the matched individual
middle_name string The last or family name of the matched individual
last_name string The last or family name of the matched individual
law_enforcement boolean true if the matched individual appears in any law enforcement datasets
nationalities string[] An array of two-letter ISO Alpha-2 Country Code country codes indicating the matched individual's nationality or nationalities
pep boolean true if the matched individual is considered a Politically Exposed Person
previously_sanctioned boolean true if the matched individual was sanctioned in the past
score number Entity match score. Higher numbers indicate higher confidence in a positive match. Min: 1, Max: 100

Example ​

{

"adverse_media": true,

"birth_date": "1958-04-08",

"currently_sanctioned": true,

"deceased": false,

"disqualified_director": false,

"financial_regulator": false,

"first_name": "Alyona",

"insolvent": false,

"last_name": "Semenov",

"law_enforcement": true,

"middle_name": null,

"nationalities": ["RU"],

"pep": false,

"previously_sanctioned": false,

"score": 73

}

Business Data Structures ​

Business Profile ​

The profile details for a given business.

Name Type Description
name string Name of business
business_type string One of the business types below
primary_contact object An Individual Profile representing the primary contact for the business (may be null based on permissions)

Business types:

note

Note that the name used here is the current "common" name the business has set in their profile settings, which may not be the same as the business's legal names used in accreditation or identity flows (the legal names in a Business Accreditation or Business Identity Details response may be different).

Example ​

{

"name": "CompuGlobalHyperMegaNet, Inc.",

"business_type": "Limited Liability Company",

"primary_contact": {

"email": "test@example.com",

"first_name": "Wyman",

"last_name": "Manderly"

}

}

Business Accreditation ​

A representation of an accreditation application by a business.

Name Type Description
id string Unique identifier for the accreditation
status string One of the statuses listed below
assertion_type string One of the types listed below
created_at ( Deprecated) string Timestamp of when the accreditation application was submitted for the business by a user. Note that created_at will be null if the user began but never finished their application.
submitted_at string Timestamp of when the accreditation application was submitted for the business by a user. Note that submitted_at will be null if the user began but never finished their application.
started_at string Timestamp of when the accreditation application was started for the business by a user.
certified_at string Timestamp of when the accreditation application was certified and accreditation certification letter was issued
expires_at string Timestamp of when the accreditation certification letter expires
rejected_at string Timestamp of when the accreditation application was rejected
cancled_at string Timestamp of when the accreditation application was canceled
name string The name of the company
documents object[] A list of Accreditation Document Record Files
rejection_reason string One of the reasons listed below (if the accreditation is rejected)
change_ids string Identifiers for the specific change entries associated with the accreditation.
reviewer_note object An Accreditation Reviewer Note regarding the accreditation.

Accreditation statuses:

Assertion types:

Accreditation application rejection reasons:

note

Note that the name given here may not match the name in the business's current Business Record Details. The name given in the accreditation assertion is the name used at the time of accreditation, and the accreditation is only valid for the business named. The name returned in the business's current Business Record Details may have changed since the time of the accreditation.

Example ​

{

"assertion_type": "income",

"change_ids": ["UG9kVXNlckRhdGFFbnRyeTo5NTA="],

"created_at": "2023-09-01T12:00:00Z",

"submitted_at": "2023-09-01T12:00:00Z",

"started_at": "2023-09-01T16:00:00Z",

"certified_at": "2023-09-01T16:00:00Z",

"expires_at": "2023-11-01T16:00:00Z",

"rejected_at": null,

"canceled_at": null,

"id": "VXNlckFjY3JlZGl0YXRpb246MQ==",

"status": "current",

"name": "Compu-Global-Hyper-Mega-Net, Inc.",

"reviewer_note": {

"text": "Waiting for additional documentation from subject.",

"created_at": "2023-09-01T16:00:00Z"

}

}

Business Consistency Summary ​

An object representing the consistency summary results for a business.

Name Type Description
address_records_match_level string One of the consistency levels (see below) for the principal location submitted by the business
address_submitter_match boolean true if the submitter's location (detected from their IP address) is consistent with the submitted business principal location or incorporation country, false otherwise
name_records_match_level string One of the consistency levels (see below) for the submitted business name
name_tax_match boolean true if the submitted business name matches business name in a tax form (if it was submitted), false otherwise
name_tax_value string The business name from a tax form if it was submitted
overall_records_match_level string One of the consistency levels (see below) representing overall consistency between identity details and records search
tin_multiple_match boolean true if records search matched multiple entities with the submitted US or foreign tax id number, false otherwise
tin_records_match_level string One of the consistency levels (see below) for the submitted US or foreign tax id number

Consistency levels:

Example ​

{

"address_records_match_level": "high",

"address_submitter_match": true,

"name_records_match_level": "medium",

"name_tax_match": true,

"name_tax_value": "Hic Sunt Leones LLC",

"overall_records_match_level": "high",

"tin_multiple_match": false,

"tin_records_match_level": "high"

}

Business Risk Monitor Match ​

Information about a potential match between a business and a sanctioned (or otherwise risky) entity.

Name Type Description
adverse_media boolean true if the matched entity appears in searched media sources linking it to serious crime (e.g. fraud, money laundering, terrorism, etc.)
currently_sanctioned boolean true if the matched entity appears in any monitored sanctions datasets
disqualified_director boolean true if the matched entity appears in any searched disqualified directors datasets
financial_regulator boolean true if the matched entity appears in any searched financial regulator datasets
insolvent boolean true if the matched entity appears in any insolvency datasets
law_enforcement boolean true if the matched entity appears in any law enforcement datasets
name string The name of the matched entity (likely the same or similar to the business name)
pep boolean true if the matched entity is considered a Politically Exposed Person
previously_sanctioned boolean true if the matched entity was sanctioned in the past
score number Entity match score. Higher numbers indicate higher confidence in a positive match. Min: 1, Max: 100
website string The matched entity's website

Example ​

{

"adverse_media": true,

"currently_sanctioned": true,

"disqualified_director": true,

"financial_regulator": true,

"insolvent": true,

"law_enforcement": true,

"name": "Hic Sunt Leones LLC",

"pep": true,

"previously_sanctioned": true,

"score": 97,

"website": "http://hic.sunt.leon.example.com"

}

Control Person ​

A reference to a control person (an individual) containing information necessary to fetch additional details about the individual.

Name Type Description
id string (Optional) Unique identifier for the controlling individual; If absent, the individual has not submitted or consented to share identity details.
type string individual
title string The title this individual holds at the Business
profile object An Individual profile

Examples ​

A full reference for an individual that has submitted and consented to share identity details will contain an id field.

{

"id": "VXNlcjoxMDMyOQ==",

"title": "Headmaster",

"type": "individual",

"profile": {

"email": "apwbd@hogwarts.co.uk",

"first_name": "Albus",

"last_name": "Dumbledore"

}

}

A partial reference for an individual that has not consented to share identity details:

{

"title": "Potions Master",

"type": "individual",

"profile": {

"first_name": "Severus",

"last_name": "Snape"

}

}

Beneficial Owner ​

A reference to a beneficial owner (an individual or a business) containing information necessary to fetch additional details about the owner individual or business.

Name Type Description
id string (Optional) Unique identifier for the beneficial owner entity; If absent, the entity has not submitted or consented to share identity details.
type string individual or business
ownership_percent number The fractional amount of direct ownership this entity has of the business business (float number > 0.0 and ≤ 1.0)
profile object A Business or Individual profile

Examples ​

A full reference for a business that has submitted and consented to share identity details will contain an id field.

{

"id": "QnVzaW5lc3M6MjEzOQ==",

"type": "business",

"ownership_percent": 0.5,

"profile": {

"business_type": "partnership-llc",

"name": "Quicksilver Inc",

"primary_contact": {

"email": "r@sun.cc",

"first_name": "Regulus",

"last_name": "Sun"

}

}

}

A partial reference for an individual that has not consented to share identity details:

{

"type": "individual",

"ownership_percent": 0.25,

"profile": {

"email": "nero@aug.us",

"first_name": "Nero",

"last_name": "Augustus"

}

}