Skip to main content
API docs by Redocly

Dataspike API (v3)

Download OpenAPI specification:Download

Introduction

Welcome to the Dataspike API! You can use our API to access AML and Docver API endpoints.

Production API endpoint: api.dataspike.io

Sandbox API endpoint: sandboxapi.dataspike.io

All API requests must contain header Content-Type: application/json

For both endpoints API Key is required and can be generated at dash.dataspike.io Developer section

You have to include API Key in each request using ds-api-token Header name

AML Screening

PEP & Sanctions Screening API

Key Features:

  1. Real-time Screening: Perform instant screenings against constantly updated PEP and sanctions databases, ensuring you have the most current information at your fingertips.

  2. Customizable Workflow: Tailor the screening process to your specific needs, setting up thresholds and alerts that suit your risk appetite.

  3. Easy Integration: Our API is designed with simplicity in mind, making integration into your applications a seamless experience.

  4. Data Security: We prioritize data security and compliance, implementing industry-leading measures to protect your sensitive information.

Historical Search Report

This route allows to retrieve the old results of your searches by search_uuid from Search API

Authorizations:
ApiKeyAuth
path Parameters
id
required
string <uuid>
Example: 01827ed4-c928-7a3c-9a30-7ab7cc169d11

Retrieve search history result by 'search_uuid'

Responses

Response Schema: application/json
requested_name
string
search_uuid
string

Search id, could be use later to fetch the existing search result

max_risk_score
string (RiskScore)
Enum: "Low" "Medium" "High"

Assigned Risk Score

Array of objects (EntityRecord)
Array
uuid
string
type
string (EntityType)
Enum: "Person" "Organization" "Country" "Vessel" "Aircraft" "CryptoWallet"

Possible types

annotation
string or null

Any general information

tags
Array of strings (Tag)
Items Enum: "Finance" "Legal" "Terrorism" "Criminal" "PEP" "Media" "Social" "Sanctions" "UnofficialSource" "Leaks" "CompanyRegistry" "Associate" "Debarred"
risk_score
string (RiskScore)
Enum: "Low" "Medium" "High"

Assigned Risk Score

object (EntityRecord.EntityFields)
updated_at
integer <int64>

epoch seconds

importance_score
number or null <double>

Relative importance score of entity, use risk_score for a final decision

Response samples

Content type
application/json
{
  • "requested_name": "string",
  • "search_uuid": "string",
  • "max_risk_score": "Low",
  • "data": [
    • {
      • "uuid": "string",
      • "type": "Person",
      • "annotation": "string",
      • "tags": [
        • "Finance"
        ],
      • "risk_score": "Low",
      • "fields": {
        • "names": [
          • {
            • "full_name": "string",
            • "first_name": "string",
            • "last_name": "string",
            • "middle_name": "string",
            • "lang": "string"
            }
          ],
        • "sources": [
          • {
            • "source_id": "string",
            • "name": "string",
            • "reason": "string",
            • "summary": "string",
            • "source_url": "string",
            • "risk_score": "Low",
            • "tags": [
              • "Finance"
              ]
            }
          ],
        • "media": [
          • {
            • "source_name": "string",
            • "source_url": "string",
            • "headline": "string",
            • "summary": "string",
            • "published_at": 0,
            • "risk_score": "Low",
            • "importance_score": 0.1,
            • "sentiment": 0.1,
            • "tags": [
              • "Finance"
              ],
            • "country_codes": [
              • "string"
              ]
            }
          ],
        • "images": [
          • {
            • "description": "string",
            • "url": "string"
            }
          ],
        • "contact_info": [
          • {
            • "emails": [
              • "string"
              ],
            • "phones": [
              • "string"
              ],
            • "websites": [
              • "string"
              ]
            }
          ],
        • "registration_ids": [
          • {
            • "id": "string",
            • "id_type": "string",
            • "date": "2019-08-24",
            • "industry": "string",
            • "country": "string"
            }
          ],
        • "addresses": [
          • {
            • "country": "string",
            • "region": "string",
            • "city": "string",
            • "postal_code": "string",
            • "address": "string"
            }
          ],
        • "genders": [
          • "Male"
          ],
        • "dates_of_birth": [
          • {
            • "gte": "1987-12-24",
            • "lte": "1987-12-24"
            }
          ],
        • "places_of_birth": [
          • {
            • "country": "string",
            • "region": "string",
            • "city": "string",
            • "postal_code": "string",
            • "address": "string"
            }
          ],
        • "dates_of_death": [
          • {
            • "gte": "1987-12-24",
            • "lte": "1987-12-24"
            }
          ],
        • "places_of_death": [
          • {
            • "country": "string",
            • "region": "string",
            • "city": "string",
            • "postal_code": "string",
            • "address": "string"
            }
          ],
        • "citizenships": [
          • "string"
          ],
        • "nationalities": [
          • "string"
          ],
        • "political_roles": [
          • {
            • "role": "string",
            • "country": "string"
            }
          ],
        • "occupations": [
          • {
            • "occupation": "string",
            • "country": "string"
            }
          ],
        • "companies_and_enterprises": [
          • {
            • "name": "string",
            • "reference": "string",
            • "role": "string",
            • "country": "string"
            }
          ],
        • "owners_and_beneficiaries": [
          • {
            • "name": "string",
            • "reference": "string",
            • "role": "string",
            • "country": "string"
            }
          ],
        • "associates": [
          • {
            • "uuid": "string",
            • "name": "string",
            • "start_date": {
              • "gte": "1987-12-24",
              • "lte": "1987-12-24"
              },
            • "end_date": {
              • "gte": "1987-12-24",
              • "lte": "1987-12-24"
              },
            • "relationship": "string",
            • "is_relative": true
            }
          ]
        },
      • "updated_at": 0,
      • "importance_score": 0.1
      }
    ]
}

Applicants

Applicant API

The Applicant API provides a powerful and flexible solution for creating new applicants, conducting AML (Anti-Money Laundering) checks, performing document verifications, and enabling customizable applicant monitoring settings. This API is designed to seamlessly integrate with your existing systems, allowing you to efficiently manage applicant data and compliance processes.

Key Features:

  1. Create New Applicants: The Applicant API enables you to programmatically create new applicant profiles by providing essential details such as name or identification data.
  2. AML Checks: Efficiently conduct Anti-Money Laundering checks on applicants to ensure compliance with regulatory requirements and prevent fraudulent activities. The API leverages industry-leading AML databases to screen applicants against sanctions lists and other watchlists.
  3. Customizable Monitoring Settings: With the Applicant API, you have the freedom to tailor applicant monitoring settings according to your specific compliance needs. You can configure the frequency of screening applicants against sanctions lists, enabling you to stay up-to-date with any changes in their status.

Create New Applicant

Submit applicant details, such as name, contact information or identification data, in JSON format to create a new applicant profile. The API will respond with a unique applicant ID for further interactions.

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Create Applicant Request

One of
external_id
string

This is a unique identifier originating from your system, which will be associated and linked to the corresponding Applicant ID in our system.

email
string or null

applicant email

phone
string or null

applicant phone number

object (ApplicantPersonExternalInfo)

This object allows you to include any supplementary information about the applicant, such as their first, last name or citizenship.

full_name
string

Full Person name, if not specified will fallback to first_name and last name

first_name
string

First name

last_name
string

Last name

dob
string <ISO-8601>

Date of birth in ISO-8601 format

gender
string
Enum: "M" "F"

gender that is used in official documents

citizenship
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Currently can be set via manual fields feature via API when creating applicants. (Available in provided_info in applicant)

country
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Country extracted from POI document. (Available in system_info in applicant)

address
string

Applicant address, could be used for any type of applicants

object (ApplicantAddresses)

List of applicant addresses, only residence for now.

object (FullAddress)

Detailed address

country
required
string

ISO 3166-1 ALPHA-2 code

city
required
string

City name

postal_code
required
string

postal code (or zip) for the address.

street
required
string

Street adress line

custom_fields
object (CustomFields)

Key - value object, values can be only strings

aml_screening_enabled
boolean or null
Default: false

Enables the option to activate or deactivate daily AML monitoring for applicants. When an applicant is identified in any Sanction List during the monitoring process, a notification will be triggered through the configured Webhooks.

applicant_type
string (EntityType)
Enum: "Person" "Organization" "Country" "Vessel" "Aircraft" "CryptoWallet"

Possible types

object or null (ApplicantSearchOptions)

The Search Options functionality is intended for the customization of applicant AML monitoring

risk_scores
Array of strings or null (RiskScore)
Enum: "Low" "Medium" "High"
tags
Array of strings or null (Tag)
Enum: "Finance" "Legal" "Terrorism" "Criminal" "PEP" "Media" "Social" "Sanctions" "UnofficialSource" "Leaks" "CompanyRegistry" "Associate" "Debarred"
sources
Array of strings or null (SourceId)
fuzziness
boolean or null
Default: true
phonetics
boolean or null
Default: true
mode
integer or null
Default: 0
Enum: 0 1 2

0 - AUTO(Recommended), Automatically optimize query - full_name serves as the primary search term, unless both the first and last names are provided. In such a scenario, the combination of the first and last names becomes the primary term, and the full_name is employed to enhance the relevance of results.

1 - FULL_NAME_ONLY, ignores first_name and last_name fields, and only use full_name in search requests

2 - FIRST_AND_LAST_NAMES_ONLY, ignores full_name field and uses only combination of first_name and last_name in search requests

Responses

Response Schema: application/json
id
string <uuid>

Id of created applicant

Request samples

Content type
application/json
Example
{
  • "external_id": "external_user_id_123",
  • "email": "[email protected]",
  • "phone": "+1234567890",
  • "info": {
    • "full_name": "John Doe",
    • "first_name": "John",
    • "last_name": "Doe",
    • "dob": "1987-12-24",
    • "gender": "M",
    • "citizenship": "DE",
    • "country": "DE",
    • "address": "Paris, France",
    • "addresses": {
      • "residence": {
        • "country": "DE",
        • "city": "Berlin",
        • "postal_code": "10999",
        • "street": "Wiener Straße 17"
        }
      },
    • "custom_fields": { }
    },
  • "aml_screening_enabled": false,
  • "applicant_type": "Person",
  • "search_options": {
    • "risk_scores": [
      • "Low"
      ],
    • "tags": [
      • "Finance"
      ],
    • "sources": [
      • "string"
      ],
    • "fuzziness": true,
    • "phonetics": true,
    • "mode": 0
    }
}

Response samples

Content type
application/json
{
  • "id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11"
}

List existing applicants

Allows to retrieve a collection of existing applicant profiles within the system.

Authorizations:
ApiKeyAuth
query Parameters
page
integer
Default: 0

Current page

limit
integer
Default: 10

Limit of returned applicants per page

Responses

Response Schema: application/json
required
Array of objects or objects

List of an existing paginated items

Array
One of
applicant_id
string <uuid>

Applicant ID in Dataspike system

external_id
string or null

This is a unique identifier originating from your system, associated and linked to the corresponding Applicant ID in our system.

type
string (EntityType)
Enum: "Person" "Organization" "Country" "Vessel" "Aircraft" "CryptoWallet"

Possible types

email
string or null

applicant email

phone
string or null

applicant phone number

ApplicantPersonExternalInfo (object)

Additional info, generated during verification process by system

ApplicantPersonExternalInfo (object)

External data provided during applicant creation

last_verification_id
string or null <uuid>

The id of last document verification

verification_status
string (ApplicantVerificationStatus)
Enum: "initial" "passed" "failed"

Status of applicant's last verification. Initial if applicant doesn't have a completed verification.

aml_screening_enabled
boolean or null
Default: false

Describes whether AML screening option is enabled for specified Applicant or disabled

last_aml_screening_id
string or null <uuid>

Id of the last screening operation

last_screened_at
string or null <ISO-8601>

Timestamp of the last screening operation

last_risk_score
string (RiskScore)
Enum: "Low" "Medium" "High"

Assigned Risk Score

last_tags
Array of strings or null (Tag)
Enum: "Finance" "Legal" "Terrorism" "Criminal" "PEP" "Media" "Social" "Sanctions" "UnofficialSource" "Leaks" "CompanyRegistry" "Associate" "Debarred"

List of tags of the last screening operation

tg_profile
string or null

Telegram ID linked to Applicant

object or null (ApplicantSearchOptions)

The Search Options functionality is intended for the customization of applicant AML monitoring

has_next
boolean
Default: false

This property serves as an indicator of whether there is a next page available in the paginated result

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "external_id": "external_user_id_123",
      • "type": "Person",
      • "email": "[email protected]",
      • "phone": "+1234567890",
      • "system_info": {
        • "full_name": "John Doe",
        • "first_name": "John",
        • "last_name": "Doe",
        • "dob": "1987-12-24",
        • "gender": "M",
        • "citizenship": "DE",
        • "country": "DE",
        • "address": "Paris, France",
        • "addresses": {
          • "residence": {
            • "country": "DE",
            • "city": "Berlin",
            • "postal_code": "10999",
            • "street": "Wiener Straße 17"
            }
          },
        • "custom_fields": { }
        },
      • "provided_info": {
        • "full_name": "John Doe",
        • "first_name": "John",
        • "last_name": "Doe",
        • "dob": "1987-12-24",
        • "gender": "M",
        • "citizenship": "DE",
        • "country": "DE",
        • "address": "Paris, France",
        • "addresses": {
          • "residence": {
            • "country": "DE",
            • "city": "Berlin",
            • "postal_code": "10999",
            • "street": "Wiener Straße 17"
            }
          },
        • "custom_fields": { }
        },
      • "last_verification_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "verification_status": "initial",
      • "aml_screening_enabled": false,
      • "last_aml_screening_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "last_screened_at": "2023-07-18T15:32:13Z",
      • "last_risk_score": "Low",
      • "last_tags": [
        • "Finance"
        ],
      • "tg_profile": "1234567890",
      • "search_options": {
        • "risk_scores": [
          • "Low"
          ],
        • "tags": [
          • "Finance"
          ],
        • "sources": [
          • "string"
          ],
        • "fuzziness": true,
        • "phonetics": true,
        • "mode": 0
        }
      }
    ],
  • "has_next": false
}

Get Existing Applicant

Retrieve detailed information about an existing applicant by providing their unique Applicant ID as a URL parameter.

Authorizations:
ApiKeyAuth
path Parameters
applicant_id
required
string <uuid>
Example: 01827ed5-c228-7a3c-9a31-7ab7cc169d13

Existing aapplicant id

Responses

Response Schema: application/json
One of
applicant_id
string <uuid>

Applicant ID in Dataspike system

external_id
string or null

This is a unique identifier originating from your system, associated and linked to the corresponding Applicant ID in our system.

type
string (EntityType)
Enum: "Person" "Organization" "Country" "Vessel" "Aircraft" "CryptoWallet"

Possible types

email
string or null

applicant email

phone
string or null

applicant phone number

ApplicantPersonExternalInfo (object)

Additional info, generated during verification process by system

One of
full_name
string

Full Person name, if not specified will fallback to first_name and last name

first_name
string

First name

last_name
string

Last name

dob
string <ISO-8601>

Date of birth in ISO-8601 format

gender
string
Enum: "M" "F"

gender that is used in official documents

citizenship
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Currently can be set via manual fields feature via API when creating applicants. (Available in provided_info in applicant)

country
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Country extracted from POI document. (Available in system_info in applicant)

address
string

Applicant address, could be used for any type of applicants

object (ApplicantAddresses)

List of applicant addresses, only residence for now.

object (FullAddress)

Detailed address

country
required
string

ISO 3166-1 ALPHA-2 code

city
required
string

City name

postal_code
required
string

postal code (or zip) for the address.

street
required
string

Street adress line

custom_fields
object (CustomFields)

Key - value object, values can be only strings

ApplicantPersonExternalInfo (object)

External data provided during applicant creation

One of
full_name
string

Full Person name, if not specified will fallback to first_name and last name

first_name
string

First name

last_name
string

Last name

dob
string <ISO-8601>

Date of birth in ISO-8601 format

gender
string
Enum: "M" "F"

gender that is used in official documents

citizenship
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Currently can be set via manual fields feature via API when creating applicants. (Available in provided_info in applicant)

country
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Country extracted from POI document. (Available in system_info in applicant)

address
string

Applicant address, could be used for any type of applicants

object (ApplicantAddresses)

List of applicant addresses, only residence for now.

object (FullAddress)

Detailed address

country
required
string

ISO 3166-1 ALPHA-2 code

city
required
string

City name

postal_code
required
string

postal code (or zip) for the address.

street
required
string

Street adress line

custom_fields
object (CustomFields)

Key - value object, values can be only strings

last_verification_id
string or null <uuid>

The id of last document verification

verification_status
string (ApplicantVerificationStatus)
Enum: "initial" "passed" "failed"

Status of applicant's last verification. Initial if applicant doesn't have a completed verification.

aml_screening_enabled
boolean or null
Default: false

Describes whether AML screening option is enabled for specified Applicant or disabled

last_aml_screening_id
string or null <uuid>

Id of the last screening operation

last_screened_at
string or null <ISO-8601>

Timestamp of the last screening operation

last_risk_score
string (RiskScore)
Enum: "Low" "Medium" "High"

Assigned Risk Score

last_tags
Array of strings or null (Tag)
Enum: "Finance" "Legal" "Terrorism" "Criminal" "PEP" "Media" "Social" "Sanctions" "UnofficialSource" "Leaks" "CompanyRegistry" "Associate" "Debarred"

List of tags of the last screening operation

tg_profile
string or null

Telegram ID linked to Applicant

object or null (ApplicantSearchOptions)

The Search Options functionality is intended for the customization of applicant AML monitoring

risk_scores
Array of strings or null (RiskScore)
Enum: "Low" "Medium" "High"
tags
Array of strings or null (Tag)
Enum: "Finance" "Legal" "Terrorism" "Criminal" "PEP" "Media" "Social" "Sanctions" "UnofficialSource" "Leaks" "CompanyRegistry" "Associate" "Debarred"
sources
Array of strings or null (SourceId)
fuzziness
boolean or null
Default: true
phonetics
boolean or null
Default: true
mode
integer or null
Default: 0
Enum: 0 1 2

0 - AUTO(Recommended), Automatically optimize query - full_name serves as the primary search term, unless both the first and last names are provided. In such a scenario, the combination of the first and last names becomes the primary term, and the full_name is employed to enhance the relevance of results.

1 - FULL_NAME_ONLY, ignores first_name and last_name fields, and only use full_name in search requests

2 - FIRST_AND_LAST_NAMES_ONLY, ignores full_name field and uses only combination of first_name and last_name in search requests

Response samples

Content type
application/json
Example
{
  • "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "external_id": "external_user_id_123",
  • "type": "Person",
  • "email": "[email protected]",
  • "phone": "+1234567890",
  • "system_info": {
    • "full_name": "John Doe",
    • "first_name": "John",
    • "last_name": "Doe",
    • "dob": "1987-12-24",
    • "gender": "M",
    • "citizenship": "DE",
    • "country": "DE",
    • "address": "Paris, France",
    • "addresses": {
      • "residence": {
        • "country": "DE",
        • "city": "Berlin",
        • "postal_code": "10999",
        • "street": "Wiener Straße 17"
        }
      },
    • "custom_fields": { }
    },
  • "provided_info": {
    • "full_name": "John Doe",
    • "first_name": "John",
    • "last_name": "Doe",
    • "dob": "1987-12-24",
    • "gender": "M",
    • "citizenship": "DE",
    • "country": "DE",
    • "address": "Paris, France",
    • "addresses": {
      • "residence": {
        • "country": "DE",
        • "city": "Berlin",
        • "postal_code": "10999",
        • "street": "Wiener Straße 17"
        }
      },
    • "custom_fields": { }
    },
  • "last_verification_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "verification_status": "initial",
  • "aml_screening_enabled": false,
  • "last_aml_screening_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "last_screened_at": "2023-07-18T15:32:13Z",
  • "last_risk_score": "Low",
  • "last_tags": [
    • "Finance"
    ],
  • "tg_profile": "1234567890",
  • "search_options": {
    • "risk_scores": [
      • "Low"
      ],
    • "tags": [
      • "Finance"
      ],
    • "sources": [
      • "string"
      ],
    • "fuzziness": true,
    • "phonetics": true,
    • "mode": 0
    }
}

Update applicant info

Update provided information of applicant.

Send explicit null to remove the field value. For example: {"country": null}

Beta

Authorizations:
ApiKeyAuth
path Parameters
applicant_id
required
string <uuid>
Example: 01827ed5-c228-7a3c-9a31-7ab7cc169d13

Existing aapplicant id

Request Body schema: application/json

Applicant info

One of
full_name
string

Full Person name, if not specified will fallback to first_name and last name

first_name
string

First name

last_name
string

Last name

dob
string <ISO-8601>

Date of birth in ISO-8601 format

gender
string
Enum: "M" "F"

gender that is used in official documents

citizenship
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Currently can be set via manual fields feature via API when creating applicants. (Available in provided_info in applicant)

country
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Country extracted from POI document. (Available in system_info in applicant)

address
string

Applicant address, could be used for any type of applicants

object (ApplicantAddresses)

List of applicant addresses, only residence for now.

object (FullAddress)

Detailed address

country
required
string

ISO 3166-1 ALPHA-2 code

city
required
string

City name

postal_code
required
string

postal code (or zip) for the address.

street
required
string

Street adress line

custom_fields
object (CustomFields)

Key - value object, values can be only strings

Responses

Request samples

Content type
application/json
Example
{
  • "full_name": "John Doe",
  • "first_name": "John",
  • "last_name": "Doe",
  • "dob": "1987-12-24",
  • "gender": "M",
  • "citizenship": "DE",
  • "country": "DE",
  • "address": "Paris, France",
  • "addresses": {
    • "residence": {
      • "country": "DE",
      • "city": "Berlin",
      • "postal_code": "10999",
      • "street": "Wiener Straße 17"
      }
    },
  • "custom_fields": { }
}

Delete Existing Applicant

The API enables the deletion of an applicant from the applicants list while ensuring the preservation of all data through archiving.

Authorizations:
ApiKeyAuth
path Parameters
applicant_id
required
string <uuid>
Example: 01827ed4-c928-7a3c-9a30-7ab7cc169d11

Delete Applicant by ID

Responses

Get Applicant by External id

Retrieve detailed information about an existing applicant by providing their unique External ID as a URL parameter.

Authorizations:
ApiKeyAuth
path Parameters
external_id
required
string

External id of applicant

Responses

Response Schema: application/json
One of
applicant_id
string <uuid>

Applicant ID in Dataspike system

external_id
string or null

This is a unique identifier originating from your system, associated and linked to the corresponding Applicant ID in our system.

type
string (EntityType)
Enum: "Person" "Organization" "Country" "Vessel" "Aircraft" "CryptoWallet"

Possible types

email
string or null

applicant email

phone
string or null

applicant phone number

ApplicantPersonExternalInfo (object)

Additional info, generated during verification process by system

One of
full_name
string

Full Person name, if not specified will fallback to first_name and last name

first_name
string

First name

last_name
string

Last name

dob
string <ISO-8601>

Date of birth in ISO-8601 format

gender
string
Enum: "M" "F"

gender that is used in official documents

citizenship
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Currently can be set via manual fields feature via API when creating applicants. (Available in provided_info in applicant)

country
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Country extracted from POI document. (Available in system_info in applicant)

address
string

Applicant address, could be used for any type of applicants

object (ApplicantAddresses)

List of applicant addresses, only residence for now.

object (FullAddress)

Detailed address

country
required
string

ISO 3166-1 ALPHA-2 code

city
required
string

City name

postal_code
required
string

postal code (or zip) for the address.

street
required
string

Street adress line

custom_fields
object (CustomFields)

Key - value object, values can be only strings

ApplicantPersonExternalInfo (object)

External data provided during applicant creation

One of
full_name
string

Full Person name, if not specified will fallback to first_name and last name

first_name
string

First name

last_name
string

Last name

dob
string <ISO-8601>

Date of birth in ISO-8601 format

gender
string
Enum: "M" "F"

gender that is used in official documents

citizenship
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Currently can be set via manual fields feature via API when creating applicants. (Available in provided_info in applicant)

country
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Country extracted from POI document. (Available in system_info in applicant)

address
string

Applicant address, could be used for any type of applicants

object (ApplicantAddresses)

List of applicant addresses, only residence for now.

object (FullAddress)

Detailed address

country
required
string

ISO 3166-1 ALPHA-2 code

city
required
string

City name

postal_code
required
string

postal code (or zip) for the address.

street
required
string

Street adress line

custom_fields
object (CustomFields)

Key - value object, values can be only strings

last_verification_id
string or null <uuid>

The id of last document verification

verification_status
string (ApplicantVerificationStatus)
Enum: "initial" "passed" "failed"

Status of applicant's last verification. Initial if applicant doesn't have a completed verification.

aml_screening_enabled
boolean or null
Default: false

Describes whether AML screening option is enabled for specified Applicant or disabled

last_aml_screening_id
string or null <uuid>

Id of the last screening operation

last_screened_at
string or null <ISO-8601>

Timestamp of the last screening operation

last_risk_score
string (RiskScore)
Enum: "Low" "Medium" "High"

Assigned Risk Score

last_tags
Array of strings or null (Tag)
Enum: "Finance" "Legal" "Terrorism" "Criminal" "PEP" "Media" "Social" "Sanctions" "UnofficialSource" "Leaks" "CompanyRegistry" "Associate" "Debarred"

List of tags of the last screening operation

tg_profile
string or null

Telegram ID linked to Applicant

object or null (ApplicantSearchOptions)

The Search Options functionality is intended for the customization of applicant AML monitoring

risk_scores
Array of strings or null (RiskScore)
Enum: "Low" "Medium" "High"
tags
Array of strings or null (Tag)
Enum: "Finance" "Legal" "Terrorism" "Criminal" "PEP" "Media" "Social" "Sanctions" "UnofficialSource" "Leaks" "CompanyRegistry" "Associate" "Debarred"
sources
Array of strings or null (SourceId)
fuzziness
boolean or null
Default: true
phonetics
boolean or null
Default: true
mode
integer or null
Default: 0
Enum: 0 1 2

0 - AUTO(Recommended), Automatically optimize query - full_name serves as the primary search term, unless both the first and last names are provided. In such a scenario, the combination of the first and last names becomes the primary term, and the full_name is employed to enhance the relevance of results.

1 - FULL_NAME_ONLY, ignores first_name and last_name fields, and only use full_name in search requests

2 - FIRST_AND_LAST_NAMES_ONLY, ignores full_name field and uses only combination of first_name and last_name in search requests

Response samples

Content type
application/json
Example
{
  • "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "external_id": "external_user_id_123",
  • "type": "Person",
  • "email": "[email protected]",
  • "phone": "+1234567890",
  • "system_info": {
    • "full_name": "John Doe",
    • "first_name": "John",
    • "last_name": "Doe",
    • "dob": "1987-12-24",
    • "gender": "M",
    • "citizenship": "DE",
    • "country": "DE",
    • "address": "Paris, France",
    • "addresses": {
      • "residence": {
        • "country": "DE",
        • "city": "Berlin",
        • "postal_code": "10999",
        • "street": "Wiener Straße 17"
        }
      },
    • "custom_fields": { }
    },
  • "provided_info": {
    • "full_name": "John Doe",
    • "first_name": "John",
    • "last_name": "Doe",
    • "dob": "1987-12-24",
    • "gender": "M",
    • "citizenship": "DE",
    • "country": "DE",
    • "address": "Paris, France",
    • "addresses": {
      • "residence": {
        • "country": "DE",
        • "city": "Berlin",
        • "postal_code": "10999",
        • "street": "Wiener Straße 17"
        }
      },
    • "custom_fields": { }
    },
  • "last_verification_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "verification_status": "initial",
  • "aml_screening_enabled": false,
  • "last_aml_screening_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "last_screened_at": "2023-07-18T15:32:13Z",
  • "last_risk_score": "Low",
  • "last_tags": [
    • "Finance"
    ],
  • "tg_profile": "1234567890",
  • "search_options": {
    • "risk_scores": [
      • "Low"
      ],
    • "tags": [
      • "Finance"
      ],
    • "sources": [
      • "string"
      ],
    • "fuzziness": true,
    • "phonetics": true,
    • "mode": 0
    }
}

Change Applicant Search Options

Allow to customize search options for each applicant

Authorizations:
ApiKeyAuth
path Parameters
applicant_id
required
string <uuid>
Example: 01827ed4-c928-7a3c-9a30-7ab7cc169d11

Search Options Applicant ID

Request Body schema: application/json

Search Options Applicant Request

One of
risk_scores
Array of strings or null (RiskScore)
Enum: "Low" "Medium" "High"
tags
Array of strings or null (Tag)
Enum: "Finance" "Legal" "Terrorism" "Criminal" "PEP" "Media" "Social" "Sanctions" "UnofficialSource" "Leaks" "CompanyRegistry" "Associate" "Debarred"
sources
Array of strings or null (SourceId)
fuzziness
boolean or null
Default: true
phonetics
boolean or null
Default: true
mode
integer or null
Default: 0
Enum: 0 1 2

0 - AUTO(Recommended), Automatically optimize query - full_name serves as the primary search term, unless both the first and last names are provided. In such a scenario, the combination of the first and last names becomes the primary term, and the full_name is employed to enhance the relevance of results.

1 - FULL_NAME_ONLY, ignores first_name and last_name fields, and only use full_name in search requests

2 - FIRST_AND_LAST_NAMES_ONLY, ignores full_name field and uses only combination of first_name and last_name in search requests

Responses

Request samples

Content type
application/json
{
  • "risk_scores": [
    • "Low"
    ],
  • "tags": [
    • "Finance"
    ],
  • "sources": [
    • "string"
    ],
  • "fuzziness": true,
  • "phonetics": true,
  • "mode": 0
}

Latest AML Report

Fetch latest AML Report for an applicant

Authorizations:
ApiKeyAuth
path Parameters
applicant_id
required
string <uuid>
Example: f81d4fae-7dec-11d0-a765-00a0c91e6bf6

Applicant ID

Responses

Response Schema: application/json
requested_name
string
search_uuid
string

Search id, could be use later to fetch the existing search result

max_risk_score
string (RiskScore)
Enum: "Low" "Medium" "High"

Assigned Risk Score

Array of objects (EntityRecord)
Array
uuid
string
type
string (EntityType)
Enum: "Person" "Organization" "Country" "Vessel" "Aircraft" "CryptoWallet"

Possible types

annotation
string or null

Any general information

tags
Array of strings (Tag)
Items Enum: "Finance" "Legal" "Terrorism" "Criminal" "PEP" "Media" "Social" "Sanctions" "UnofficialSource" "Leaks" "CompanyRegistry" "Associate" "Debarred"
risk_score
string (RiskScore)
Enum: "Low" "Medium" "High"

Assigned Risk Score

object (EntityRecord.EntityFields)
updated_at
integer <int64>

epoch seconds

importance_score
number or null <double>

Relative importance score of entity, use risk_score for a final decision

Response samples

Content type
application/json
{
  • "requested_name": "string",
  • "search_uuid": "string",
  • "max_risk_score": "Low",
  • "data": [
    • {
      • "uuid": "string",
      • "type": "Person",
      • "annotation": "string",
      • "tags": [
        • "Finance"
        ],
      • "risk_score": "Low",
      • "fields": {
        • "names": [
          • {
            • "full_name": "string",
            • "first_name": "string",
            • "last_name": "string",
            • "middle_name": "string",
            • "lang": "string"
            }
          ],
        • "sources": [
          • {
            • "source_id": "string",
            • "name": "string",
            • "reason": "string",
            • "summary": "string",
            • "source_url": "string",
            • "risk_score": "Low",
            • "tags": [
              • "Finance"
              ]
            }
          ],
        • "media": [
          • {
            • "source_name": "string",
            • "source_url": "string",
            • "headline": "string",
            • "summary": "string",
            • "published_at": 0,
            • "risk_score": "Low",
            • "importance_score": 0.1,
            • "sentiment": 0.1,
            • "tags": [
              • "Finance"
              ],
            • "country_codes": [
              • "string"
              ]
            }
          ],
        • "images": [
          • {
            • "description": "string",
            • "url": "string"
            }
          ],
        • "contact_info": [
          • {
            • "emails": [
              • "string"
              ],
            • "phones": [
              • "string"
              ],
            • "websites": [
              • "string"
              ]
            }
          ],
        • "registration_ids": [
          • {
            • "id": "string",
            • "id_type": "string",
            • "date": "2019-08-24",
            • "industry": "string",
            • "country": "string"
            }
          ],
        • "addresses": [
          • {
            • "country": "string",
            • "region": "string",
            • "city": "string",
            • "postal_code": "string",
            • "address": "string"
            }
          ],
        • "genders": [
          • "Male"
          ],
        • "dates_of_birth": [
          • {
            • "gte": "1987-12-24",
            • "lte": "1987-12-24"
            }
          ],
        • "places_of_birth": [
          • {
            • "country": "string",
            • "region": "string",
            • "city": "string",
            • "postal_code": "string",
            • "address": "string"
            }
          ],
        • "dates_of_death": [
          • {
            • "gte": "1987-12-24",
            • "lte": "1987-12-24"
            }
          ],
        • "places_of_death": [
          • {
            • "country": "string",
            • "region": "string",
            • "city": "string",
            • "postal_code": "string",
            • "address": "string"
            }
          ],
        • "citizenships": [
          • "string"
          ],
        • "nationalities": [
          • "string"
          ],
        • "political_roles": [
          • {
            • "role": "string",
            • "country": "string"
            }
          ],
        • "occupations": [
          • {
            • "occupation": "string",
            • "country": "string"
            }
          ],
        • "companies_and_enterprises": [
          • {
            • "name": "string",
            • "reference": "string",
            • "role": "string",
            • "country": "string"
            }
          ],
        • "owners_and_beneficiaries": [
          • {
            • "name": "string",
            • "reference": "string",
            • "role": "string",
            • "country": "string"
            }
          ],
        • "associates": [
          • {
            • "uuid": "string",
            • "name": "string",
            • "start_date": {
              • "gte": "1987-12-24",
              • "lte": "1987-12-24"
              },
            • "end_date": {
              • "gte": "1987-12-24",
              • "lte": "1987-12-24"
              },
            • "relationship": "string",
            • "is_relative": true
            }
          ]
        },
      • "updated_at": 0,
      • "importance_score": 0.1
      }
    ]
}

Enable monitoring

Enable monitoring for applicant

Authorizations:
ApiKeyAuth
path Parameters
applicant_id
required
string <uuid>
Example: f81d4fae-7dec-11d0-a765-00a0c91e6bf6

Applicant ID

Responses

Response Schema: application/json
string

Response samples

Content type
application/json
"enabled successfully"

Verifications

Verification API

The Document Verification API offers a cutting-edge and secure solution for verifying the authenticity and validity of identity documents submitted by applicants within application or platform. This powerful API leverages advanced document recognition and verification technologies to streamline the verification process and improve overall user onboarding experience.

Key Features:

  1. Identity Document Validation: The API supports various types of identity documents, such as passports, driver's licenses and more. It automatically extracts relevant information from these documents, ensuring seamless and reliable validation.
  2. Biometric Verification: For added security and fraud prevention, the API can perform biometric verification by comparing the photo on the identity document with a selfie or live photo provided by the applicant.
  3. Real-Time Verification Results: Verification results are provided in real-time, enabling swift decision-making in onboarding processes and other critical operations.

Create New Verification

Use this endpoint to request a new verification process for an applicant. Developers must provide the applicant's unique identifier and specify the type of verification required.

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Create Verification Request

applicant_id
string <uuid>

Applicant ID, for which the verification will be linked to, if omitted then new random Applicant will be created automatically

checks_required
Array of strings (DocumentType)
Deprecated
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

Deprecated, please use verification profiles instead. List of verification checkes, that will be performed for the end-user. In case of empty required checks will be gathered from profile.

profile_id
string <uuid>

Verification profile id, if ommited default will be used. Verification profile defines allowed document types, countries and other verification settings.

applicant_country
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes

expiration_minutes
integer
Default: 240

The expiration_minutes field is an optional integer value representing the duration after the verification creation when verifications are still valid. The default value is 240 minutes, and the allowed range for this field is from 1 to 10080 minutes.

object (VerificationSandboxResult)

Predefined result of verification. Only valid for sandbox environment.

status
string
Enum: "initial" "pending" "in_progress" "verified" "failed" "canceled" "expired"

Predefined status

object
document_mrz
Array of integers (VerificationErrorCode)

MRZ check errors

face_comparison
Array of integers (VerificationErrorCode)

Face comparison check, can be within selfie or liveness_photo documents

poa
Array of integers (VerificationErrorCode)

Proof of Address check

liveness
Array of integers (VerificationErrorCode)

Liveness check, verify that provided image is not spoofed

Responses

Response Schema: application/json
id
required
string <uuid>

Id of created verification

applicant_id
required
string <uuid>

Id of applicant verification is linked to

status
required
string (VerificationStatus)
Enum: "initial" "pending" "in_progress" "verified" "failed" "canceled" "expired"

The First verification status is initial.

Second one is pending, when some documents are uploaded to verification or applicant of verification, but not all required documents are uploaded.

When all documents are uploaded and verification has been proceeded by api (https://docs.dataspike.io/api#tag/Verifications/operation/proceed-verification) or web sdk status becomes to in_progress.

After in_progress status can be both verified or failed depending on the verification result.

Transition to canceled status can be from any status if verification was canceled, except verified and failed.

Transition to expired status can be from any status if verification has expired, except verified, in_progress and failed.

Flow of status

Array of objects

List of prodived documents

Array
document_id
string <uuid>

Document id in the system

document_type
string (DocumentType)
Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

Possible document type

required
object (CheckObject)

Object describes required checks and it`s current status

object or null

MRZ check

object or null
status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
object

Face comparison check, can be within selfie or liveness_photo documents

status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
object

Proof of Address check

status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
object

Liveness check, verify that provided image is not spoofed

status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
created_at
required
string <ISO-8601>

Verification creation timestamp

completed_at
string <ISO-8601>

Time of completion

verification_url
required
string

Verification url that can be provided to the end user to perform online verification

verification_url_id
required
string

Verification short id

country_code
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes

expires_at
required
string <ISO-8601>

Verification expiration timestamp

object (PoiData)
parsed_type
string (DocumentType)
Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

Possible document type

has_mrz
boolean

Indicate document has mrz or not

raw_mrz_type
string

mrz type of document

country
string <ISO 3166-1 ALPHA-3 code>

Country of the document, reference https://www.iban.com/country-codes

full_name
string

If present name and surname will be empty strings

name
string

Extracted name

surname
string

Extracted surname

document_number
string

Document number

nationality
string <ISO 3166-1 ALPHA-3 code>

Extracted nationality

birth_date
string <ISO-8601 date>

Extracted birth date

sex
string

Extracted sex, M or F

expiry_date
string <ISO-8601 date>

Extracted birth date

issue_date
string <ISO-8601 date>

Extracted birth date

pin
string

Pin of document.

card_number
string

Number of card.

license_number
string
license_type
string
license_class
string
cpf_number
string
vin
string
nin
string
occupation
string
polling_unit
string
region
string
restrictions
string
height
string
registration_date
string
parents_names
string
endorsements
string
is_sandbox
required
boolean
Default: false

Flag indicates that verification is created in sandbox env

profile_id
required
string <uuid>

Verification profile id

required
object (VerificationProfileSettings)

Verification profile settings

poi_required
required
boolean
Default: true

POI (proof of identity) check is required.

poi_allowed_documents
required
Array of strings
Items Enum: "passport" "driver_license" "id_card" "residence_permit"
face_comparison_required
required
boolean
Default: true

Face comparison check is required

face_comparison_allowed_documents
required
Array of strings
Items Enum: "selfie" "liveness_photo"
poa_required
required
boolean
Default: false

POA (proof of address) check is required

disable_cross_check_by_bio
boolean
Default: false

Don't do cross check by name and birth date in POI document across organization.

disable_cross_check_by_photo
boolean
Default: false

Don't do cross check by photo of applicant across organization.

disable_verify_poa_country_match_with_poi
boolean
Default: false

Disable requirement that country in POA document should be match within country in POI document

countries
Array of strings <ISO 3166-1 ALPHA-2 code> [ items <ISO 3166-1 ALPHA-2 code > ]

List of allowed countries

allow_poi_manual_uploads
required
boolean
Default: false

Allow manual upload POI documents from files (now live photo)

allow_desktop
required
boolean
Default: false

Allow uploads throught desktop. False means only mobile allowed

ui_settings
object (UISettings)

ui settigns to customize SDK

object (ManualFieldsSettings)

Manual field settings

enabled
required
boolean
description
string
object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

Array of objects
object (LinkFinishScreenSettings)

Verification finish screen settings

enabled
required
boolean
object
aml_search_id
string <uuid>

AML search id operation

object (ManualFieldsValues)

Custom fields values

full_name
string
email
string
phone
string
country
string
dob
string

Date of birth.

gender
string
Enum: "M" "F"
citizenship
string
address
string
custom_fields
object (CustomFields)

Key - value object, values can be only strings

object (CustomFiles)

Mapping of custom field labels to uploaded document info

additional property
object

Custom file properties

document_id
required
string <UUID>
content_type
required
string

mime type

Request samples

Content type
application/json
{
  • "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "checks_required": [
    • "passport"
    ],
  • "profile_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "applicant_country": "BR-12458344",
  • "expiration_minutes": 240,
  • "sandbox_result": {
    • "status": "verified",
    • "errors": {
      • "document_mrz": [
        • 1001
        ],
      • "face_comparison": [
        • 1001
        ],
      • "poa": [
        • 1001
        ],
      • "liveness": [
        • 1001
        ]
      }
    }
}

Response samples

Content type
application/json
{
  • "id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "status": "initial",
  • "documents": [
    • {
      • "document_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "document_type": "passport"
      }
    ],
  • "checks": {
    • "document_mrz": {
      • "data": {
        • "document_type": "Passport",
        • "country": "DE",
        • "name": "John",
        • "surname": "Doe",
        • "doc_number": "P-1234567890",
        • "nationality": "British",
        • "birth_date": "871224",
        • "sex": "M",
        • "expiry_date": "201224"
        },
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      },
    • "face_comparison": {
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      },
    • "poa": {
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      },
    • "liveness": {
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      }
    },
  • "created_at": "2023-07-18T15:32:13Z",
  • "completed_at": "2023-07-18T15:32:13Z",
  • "verification_url": "https://am.dataspike.io/VDBA1B2EA6A28A7D2",
  • "verification_url_id": "VDBA1B2EA6A28A7D2",
  • "country_code": "DE",
  • "expires_at": "2023-07-18T15:32:13Z",
  • "poi_data": {
    • "parsed_type": "passport",
    • "has_mrz": true,
    • "raw_mrz_type": "P",
    • "country": "DEU",
    • "full_name": "John Doe",
    • "name": "John",
    • "surname": "Doe",
    • "document_number": "P-1234567890",
    • "nationality": "DEU",
    • "birth_date": "1983-03-21",
    • "sex": "M",
    • "expiry_date": "2021-02-24",
    • "issue_date": "2021-02-24",
    • "pin": "string",
    • "card_number": "string",
    • "license_number": "string",
    • "license_type": "string",
    • "license_class": "string",
    • "cpf_number": "string",
    • "vin": "string",
    • "nin": "string",
    • "occupation": "string",
    • "polling_unit": "string",
    • "region": "string",
    • "restrictions": "string",
    • "height": "string",
    • "registration_date": "string",
    • "parents_names": "string",
    • "endorsements": "string"
    },
  • "is_sandbox": false,
  • "profile_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "settings": {
    • "poi_required": true,
    • "poi_allowed_documents": [
      • "passport"
      ],
    • "face_comparison_required": true,
    • "face_comparison_allowed_documents": [
      • "selfie"
      ],
    • "poa_required": false,
    • "disable_cross_check_by_bio": false,
    • "disable_cross_check_by_photo": false,
    • "disable_verify_poa_country_match_with_poi": false,
    • "countries": [
      • "FR"
      ],
    • "allow_poi_manual_uploads": false,
    • "allow_desktop": false,
    • "ui_settings": { },
    • "manual_field_settings": {
      • "enabled": true,
      • "description": "string",
      • "full_name": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "email": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "phone": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "country": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "dob": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "gender": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "citizenship": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "address": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "custom_fields": [
        • {
          • "label": "string",
          • "caption": "string",
          • "order": 0,
          • "options": {
            • "choices": [
              • "string"
              ],
            • "type": "select"
            }
          }
        ]
      },
    • "finish_screen_settings": {
      • "enabled": true,
      • "settings": {
        • "title": "string",
        • "main_text": "string",
        • "redirect_warning": "string",
        • "cta": "string",
        • "redirect_link": "string"
        }
      }
    },
  • "aml_search_id": "d358ace9-9e35-42cd-b8b7-837c1005d2f5",
  • "manual_fields": {
    • "full_name": "string",
    • "email": "string",
    • "phone": "string",
    • "country": "string",
    • "dob": "string",
    • "gender": "M",
    • "citizenship": "string",
    • "address": "string",
    • "custom_fields": { }
    },
  • "custom_files": {
    • "property1": {
      • "document_id": "507a6573-60ca-499e-8950-e2ca435dfe4f",
      • "content_type": "image/jpeg"
      },
    • "property2": {
      • "document_id": "507a6573-60ca-499e-8950-e2ca435dfe4f",
      • "content_type": "image/jpeg"
      }
    }
}

List existing verifications

Allows to retrieve a collection of existing verifications within the system.

Authorizations:
ApiKeyAuth
query Parameters
page
integer
Default: 0

Current page

limit
integer
Default: 10

Limit of returned applicants per page

dob
string <ISO-8601 or short format. For example only year 1984, or year with month 1984-03>
Example: dob=1984-03-21

Date of birth.

from
string <ISO-8601>
Example: from=2023-06-21

Filter by creation time since this date

to
string <ISO-8601>
Example: to=203-07-27

Filter by creation time upon this date

status
Array of strings (VerificationStatus)
Items Enum: "initial" "pending" "in_progress" "verified" "failed" "canceled" "expired"

Filter by verification status

profile
Array of strings <UUID> [ items <UUID > ]

Filter by verification profiles

document_type
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

Filter by document types used in verification

name
string
Example: name=John Doe

Filter by name in parsed documents

country
string <ISO 31661-1 alpha-2>

Filter by country in parsed documents

Responses

Response Schema: application/json
required
Array of objects

List of an existing paginated items

Array
id
required
string <uuid>

Id of created verification

applicant_id
required
string <uuid>

Id of applicant verification is linked to

status
required
string (VerificationStatus)
Enum: "initial" "pending" "in_progress" "verified" "failed" "canceled" "expired"

The First verification status is initial.

Second one is pending, when some documents are uploaded to verification or applicant of verification, but not all required documents are uploaded.

When all documents are uploaded and verification has been proceeded by api (https://docs.dataspike.io/api#tag/Verifications/operation/proceed-verification) or web sdk status becomes to in_progress.

After in_progress status can be both verified or failed depending on the verification result.

Transition to canceled status can be from any status if verification was canceled, except verified and failed.

Transition to expired status can be from any status if verification has expired, except verified, in_progress and failed.

Flow of status

Array of objects

List of prodived documents

required
object (CheckObject)

Object describes required checks and it`s current status

created_at
required
string <ISO-8601>

Verification creation timestamp

completed_at
string <ISO-8601>

Time of completion

verification_url
required
string

Verification url that can be provided to the end user to perform online verification

verification_url_id
required
string

Verification short id

country_code
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes

expires_at
required
string <ISO-8601>

Verification expiration timestamp

object (PoiData)
is_sandbox
required
boolean
Default: false

Flag indicates that verification is created in sandbox env

profile_id
required
string <uuid>

Verification profile id

required
object (VerificationProfileSettings)

Verification profile settings

aml_search_id
string <uuid>

AML search id operation

object (ManualFieldsValues)

Custom fields values

object (CustomFiles)

Mapping of custom field labels to uploaded document info

has_next
boolean
Default: false

This property serves as an indicator of whether there is a next page available in the paginated result

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "status": "initial",
      • "documents": [
        • {
          • "document_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
          • "document_type": "passport"
          }
        ],
      • "checks": {
        • "document_mrz": {
          • "data": {
            • "document_type": "Passport",
            • "country": "DE",
            • "name": "John",
            • "surname": "Doe",
            • "doc_number": "P-1234567890",
            • "nationality": "British",
            • "birth_date": "871224",
            • "sex": "M",
            • "expiry_date": "201224"
            },
          • "status": "pending",
          • "pending_documents": [
            • "passport"
            ],
          • "errors": [
            • {
              • "code": 1001,
              • "message": "document parsing failed"
              }
            ]
          },
        • "face_comparison": {
          • "status": "pending",
          • "pending_documents": [
            • "passport"
            ],
          • "errors": [
            • {
              • "code": 1001,
              • "message": "document parsing failed"
              }
            ]
          },
        • "poa": {
          • "status": "pending",
          • "pending_documents": [
            • "passport"
            ],
          • "errors": [
            • {
              • "code": 1001,
              • "message": "document parsing failed"
              }
            ]
          },
        • "liveness": {
          • "status": "pending",
          • "pending_documents": [
            • "passport"
            ],
          • "errors": [
            • {
              • "code": 1001,
              • "message": "document parsing failed"
              }
            ]
          }
        },
      • "created_at": "2023-07-18T15:32:13Z",
      • "completed_at": "2023-07-18T15:32:13Z",
      • "verification_url": "https://am.dataspike.io/VDBA1B2EA6A28A7D2",
      • "verification_url_id": "VDBA1B2EA6A28A7D2",
      • "country_code": "DE",
      • "expires_at": "2023-07-18T15:32:13Z",
      • "poi_data": {
        • "parsed_type": "passport",
        • "has_mrz": true,
        • "raw_mrz_type": "P",
        • "country": "DEU",
        • "full_name": "John Doe",
        • "name": "John",
        • "surname": "Doe",
        • "document_number": "P-1234567890",
        • "nationality": "DEU",
        • "birth_date": "1983-03-21",
        • "sex": "M",
        • "expiry_date": "2021-02-24",
        • "issue_date": "2021-02-24",
        • "pin": "string",
        • "card_number": "string",
        • "license_number": "string",
        • "license_type": "string",
        • "license_class": "string",
        • "cpf_number": "string",
        • "vin": "string",
        • "nin": "string",
        • "occupation": "string",
        • "polling_unit": "string",
        • "region": "string",
        • "restrictions": "string",
        • "height": "string",
        • "registration_date": "string",
        • "parents_names": "string",
        • "endorsements": "string"
        },
      • "is_sandbox": false,
      • "profile_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "settings": {
        • "poi_required": true,
        • "poi_allowed_documents": [
          • "passport"
          ],
        • "face_comparison_required": true,
        • "face_comparison_allowed_documents": [
          • "selfie"
          ],
        • "poa_required": false,
        • "disable_cross_check_by_bio": false,
        • "disable_cross_check_by_photo": false,
        • "disable_verify_poa_country_match_with_poi": false,
        • "countries": [
          • "FR"
          ],
        • "allow_poi_manual_uploads": false,
        • "allow_desktop": false,
        • "ui_settings": { },
        • "manual_field_settings": {
          • "enabled": true,
          • "description": "string",
          • "full_name": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "email": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "phone": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "country": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "dob": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "gender": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "citizenship": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "address": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "custom_fields": [
            • {
              • "label": "string",
              • "caption": "string",
              • "order": 0,
              • "options": {
                • "choices": [
                  • "string"
                  ],
                • "type": "select"
                }
              }
            ]
          },
        • "finish_screen_settings": {
          • "enabled": true,
          • "settings": {
            • "title": "string",
            • "main_text": "string",
            • "redirect_warning": "string",
            • "cta": "string",
            • "redirect_link": "string"
            }
          }
        },
      • "aml_search_id": "d358ace9-9e35-42cd-b8b7-837c1005d2f5",
      • "manual_fields": {
        • "full_name": "string",
        • "email": "string",
        • "phone": "string",
        • "country": "string",
        • "dob": "string",
        • "gender": "M",
        • "citizenship": "string",
        • "address": "string",
        • "custom_fields": { }
        },
      • "custom_files": {
        • "property1": {
          • "document_id": "507a6573-60ca-499e-8950-e2ca435dfe4f",
          • "content_type": "image/jpeg"
          },
        • "property2": {
          • "document_id": "507a6573-60ca-499e-8950-e2ca435dfe4f",
          • "content_type": "image/jpeg"
          }
        }
      }
    ],
  • "has_next": false
}

Proceed with an existing Verification

To proceed verification further call this method. Should be used after all the required documents has been uploaded.

Authorizations:
ApiKeyAuth
path Parameters
verification_id
required
string <uuid>
Example: 01827ed4-c928-7a3c-9a30-7ab7cc169d11

Existing Verification Id

Responses

Cancel existing Verification

Only not started(proceed action was not performed yet) verification are allowed to be canceled.

Authorizations:
ApiKeyAuth
path Parameters
verification_id
required
string <uuid>
Example: 01827ed4-c928-7a3c-9a30-7ab7cc169d11

Existing Verification Id

Responses

Get Existing Verification

Retrieve detailed information about an existing verification by providing their unique Verification ID as a URL parameter.

Authorizations:
ApiKeyAuth
path Parameters
verification_id
required
string <uuid>
Example: 01827ed4-c928-7a3c-9a30-7ab7cc169d11

Fetch Verification by ID

Responses

Response Schema: application/json
id
required
string <uuid>

Id of created verification

applicant_id
required
string <uuid>

Id of applicant verification is linked to

status
required
string (VerificationStatus)
Enum: "initial" "pending" "in_progress" "verified" "failed" "canceled" "expired"

The First verification status is initial.

Second one is pending, when some documents are uploaded to verification or applicant of verification, but not all required documents are uploaded.

When all documents are uploaded and verification has been proceeded by api (https://docs.dataspike.io/api#tag/Verifications/operation/proceed-verification) or web sdk status becomes to in_progress.

After in_progress status can be both verified or failed depending on the verification result.

Transition to canceled status can be from any status if verification was canceled, except verified and failed.

Transition to expired status can be from any status if verification has expired, except verified, in_progress and failed.

Flow of status

Array of objects

List of prodived documents

Array
document_id
string <uuid>

Document id in the system

document_type
string (DocumentType)
Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

Possible document type

required
object (CheckObject)

Object describes required checks and it`s current status

object or null

MRZ check

object or null
status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
object

Face comparison check, can be within selfie or liveness_photo documents

status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
object

Proof of Address check

status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
object

Liveness check, verify that provided image is not spoofed

status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
created_at
required
string <ISO-8601>

Verification creation timestamp

completed_at
string <ISO-8601>

Time of completion

verification_url
required
string

Verification url that can be provided to the end user to perform online verification

verification_url_id
required
string

Verification short id

country_code
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes

expires_at
required
string <ISO-8601>

Verification expiration timestamp

object (PoiData)
parsed_type
string (DocumentType)
Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

Possible document type

has_mrz
boolean

Indicate document has mrz or not

raw_mrz_type
string

mrz type of document

country
string <ISO 3166-1 ALPHA-3 code>

Country of the document, reference https://www.iban.com/country-codes

full_name
string

If present name and surname will be empty strings

name
string

Extracted name

surname
string

Extracted surname

document_number
string

Document number

nationality
string <ISO 3166-1 ALPHA-3 code>

Extracted nationality

birth_date
string <ISO-8601 date>

Extracted birth date

sex
string

Extracted sex, M or F

expiry_date
string <ISO-8601 date>

Extracted birth date

issue_date
string <ISO-8601 date>

Extracted birth date

pin
string

Pin of document.

card_number
string

Number of card.

license_number
string
license_type
string
license_class
string
cpf_number
string
vin
string
nin
string
occupation
string
polling_unit
string
region
string
restrictions
string
height
string
registration_date
string
parents_names
string
endorsements
string
is_sandbox
required
boolean
Default: false

Flag indicates that verification is created in sandbox env

profile_id
required
string <uuid>

Verification profile id

required
object (VerificationProfileSettings)

Verification profile settings

poi_required
required
boolean
Default: true

POI (proof of identity) check is required.

poi_allowed_documents
required
Array of strings
Items Enum: "passport" "driver_license" "id_card" "residence_permit"
face_comparison_required
required
boolean
Default: true

Face comparison check is required

face_comparison_allowed_documents
required
Array of strings
Items Enum: "selfie" "liveness_photo"
poa_required
required
boolean
Default: false

POA (proof of address) check is required

disable_cross_check_by_bio
boolean
Default: false

Don't do cross check by name and birth date in POI document across organization.

disable_cross_check_by_photo
boolean
Default: false

Don't do cross check by photo of applicant across organization.

disable_verify_poa_country_match_with_poi
boolean
Default: false

Disable requirement that country in POA document should be match within country in POI document

countries
Array of strings <ISO 3166-1 ALPHA-2 code> [ items <ISO 3166-1 ALPHA-2 code > ]

List of allowed countries

allow_poi_manual_uploads
required
boolean
Default: false

Allow manual upload POI documents from files (now live photo)

allow_desktop
required
boolean
Default: false

Allow uploads throught desktop. False means only mobile allowed

ui_settings
object (UISettings)

ui settigns to customize SDK

object (ManualFieldsSettings)

Manual field settings

enabled
required
boolean
description
string
object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

Array of objects
object (LinkFinishScreenSettings)

Verification finish screen settings

enabled
required
boolean
object
aml_search_id
string <uuid>

AML search id operation

object (ManualFieldsValues)

Custom fields values

full_name
string
email
string
phone
string
country
string
dob
string

Date of birth.

gender
string
Enum: "M" "F"
citizenship
string
address
string
custom_fields
object (CustomFields)

Key - value object, values can be only strings

object (CustomFiles)

Mapping of custom field labels to uploaded document info

additional property
object

Custom file properties

document_id
required
string <UUID>
content_type
required
string

mime type

Response samples

Content type
application/json
{
  • "id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "status": "initial",
  • "documents": [
    • {
      • "document_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "document_type": "passport"
      }
    ],
  • "checks": {
    • "document_mrz": {
      • "data": {
        • "document_type": "Passport",
        • "country": "DE",
        • "name": "John",
        • "surname": "Doe",
        • "doc_number": "P-1234567890",
        • "nationality": "British",
        • "birth_date": "871224",
        • "sex": "M",
        • "expiry_date": "201224"
        },
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      },
    • "face_comparison": {
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      },
    • "poa": {
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      },
    • "liveness": {
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      }
    },
  • "created_at": "2023-07-18T15:32:13Z",
  • "completed_at": "2023-07-18T15:32:13Z",
  • "verification_url": "https://am.dataspike.io/VDBA1B2EA6A28A7D2",
  • "verification_url_id": "VDBA1B2EA6A28A7D2",
  • "country_code": "DE",
  • "expires_at": "2023-07-18T15:32:13Z",
  • "poi_data": {
    • "parsed_type": "passport",
    • "has_mrz": true,
    • "raw_mrz_type": "P",
    • "country": "DEU",
    • "full_name": "John Doe",
    • "name": "John",
    • "surname": "Doe",
    • "document_number": "P-1234567890",
    • "nationality": "DEU",
    • "birth_date": "1983-03-21",
    • "sex": "M",
    • "expiry_date": "2021-02-24",
    • "issue_date": "2021-02-24",
    • "pin": "string",
    • "card_number": "string",
    • "license_number": "string",
    • "license_type": "string",
    • "license_class": "string",
    • "cpf_number": "string",
    • "vin": "string",
    • "nin": "string",
    • "occupation": "string",
    • "polling_unit": "string",
    • "region": "string",
    • "restrictions": "string",
    • "height": "string",
    • "registration_date": "string",
    • "parents_names": "string",
    • "endorsements": "string"
    },
  • "is_sandbox": false,
  • "profile_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "settings": {
    • "poi_required": true,
    • "poi_allowed_documents": [
      • "passport"
      ],
    • "face_comparison_required": true,
    • "face_comparison_allowed_documents": [
      • "selfie"
      ],
    • "poa_required": false,
    • "disable_cross_check_by_bio": false,
    • "disable_cross_check_by_photo": false,
    • "disable_verify_poa_country_match_with_poi": false,
    • "countries": [
      • "FR"
      ],
    • "allow_poi_manual_uploads": false,
    • "allow_desktop": false,
    • "ui_settings": { },
    • "manual_field_settings": {
      • "enabled": true,
      • "description": "string",
      • "full_name": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "email": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "phone": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "country": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "dob": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "gender": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "citizenship": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "address": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "custom_fields": [
        • {
          • "label": "string",
          • "caption": "string",
          • "order": 0,
          • "options": {
            • "choices": [
              • "string"
              ],
            • "type": "select"
            }
          }
        ]
      },
    • "finish_screen_settings": {
      • "enabled": true,
      • "settings": {
        • "title": "string",
        • "main_text": "string",
        • "redirect_warning": "string",
        • "cta": "string",
        • "redirect_link": "string"
        }
      }
    },
  • "aml_search_id": "d358ace9-9e35-42cd-b8b7-837c1005d2f5",
  • "manual_fields": {
    • "full_name": "string",
    • "email": "string",
    • "phone": "string",
    • "country": "string",
    • "dob": "string",
    • "gender": "M",
    • "citizenship": "string",
    • "address": "string",
    • "custom_fields": { }
    },
  • "custom_files": {
    • "property1": {
      • "document_id": "507a6573-60ca-499e-8950-e2ca435dfe4f",
      • "content_type": "image/jpeg"
      },
    • "property2": {
      • "document_id": "507a6573-60ca-499e-8950-e2ca435dfe4f",
      • "content_type": "image/jpeg"
      }
    }
}

Get Existing Verification by Short Id

Retrieve detailed information about an existing verification by providing their unique Verification Short ID as a URL parameter.

Authorizations:
ApiKeyAuth
path Parameters
short_id
required
string
Example: VADBF34JDRYIWHW

Fetch Verification by Short ID

Responses

Response Schema: application/json
id
required
string <uuid>

Id of created verification

applicant_id
required
string <uuid>

Id of applicant verification is linked to

status
required
string (VerificationStatus)
Enum: "initial" "pending" "in_progress" "verified" "failed" "canceled" "expired"

The First verification status is initial.

Second one is pending, when some documents are uploaded to verification or applicant of verification, but not all required documents are uploaded.

When all documents are uploaded and verification has been proceeded by api (https://docs.dataspike.io/api#tag/Verifications/operation/proceed-verification) or web sdk status becomes to in_progress.

After in_progress status can be both verified or failed depending on the verification result.

Transition to canceled status can be from any status if verification was canceled, except verified and failed.

Transition to expired status can be from any status if verification has expired, except verified, in_progress and failed.

Flow of status

Array of objects

List of prodived documents

Array
document_id
string <uuid>

Document id in the system

document_type
string (DocumentType)
Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

Possible document type

required
object (CheckObject)

Object describes required checks and it`s current status

object or null

MRZ check

object or null
status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
object

Face comparison check, can be within selfie or liveness_photo documents

status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
object

Proof of Address check

status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
object

Liveness check, verify that provided image is not spoofed

status
string (CheckStatus)
Enum: "pending" "in_progress" "verified" "failed" "canceled" "expired"

Describes possible document check statuses for a specific verification

pending_documents
Array of strings (DocumentType)
Items Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

List of required documents, that were not uploaded yet

Array of objects
created_at
required
string <ISO-8601>

Verification creation timestamp

completed_at
string <ISO-8601>

Time of completion

verification_url
required
string

Verification url that can be provided to the end user to perform online verification

verification_url_id
required
string

Verification short id

country_code
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes

expires_at
required
string <ISO-8601>

Verification expiration timestamp

object (PoiData)
parsed_type
string (DocumentType)
Enum: "passport" "id_card" "residence_permit" "driver_license" "poa" "selfie" "liveness_photo"

Possible document type

has_mrz
boolean

Indicate document has mrz or not

raw_mrz_type
string

mrz type of document

country
string <ISO 3166-1 ALPHA-3 code>

Country of the document, reference https://www.iban.com/country-codes

full_name
string

If present name and surname will be empty strings

name
string

Extracted name

surname
string

Extracted surname

document_number
string

Document number

nationality
string <ISO 3166-1 ALPHA-3 code>

Extracted nationality

birth_date
string <ISO-8601 date>

Extracted birth date

sex
string

Extracted sex, M or F

expiry_date
string <ISO-8601 date>

Extracted birth date

issue_date
string <ISO-8601 date>

Extracted birth date

pin
string

Pin of document.

card_number
string

Number of card.

license_number
string
license_type
string
license_class
string
cpf_number
string
vin
string
nin
string
occupation
string
polling_unit
string
region
string
restrictions
string
height
string
registration_date
string
parents_names
string
endorsements
string
is_sandbox
required
boolean
Default: false

Flag indicates that verification is created in sandbox env

profile_id
required
string <uuid>

Verification profile id

required
object (VerificationProfileSettings)

Verification profile settings

poi_required
required
boolean
Default: true

POI (proof of identity) check is required.

poi_allowed_documents
required
Array of strings
Items Enum: "passport" "driver_license" "id_card" "residence_permit"
face_comparison_required
required
boolean
Default: true

Face comparison check is required

face_comparison_allowed_documents
required
Array of strings
Items Enum: "selfie" "liveness_photo"
poa_required
required
boolean
Default: false

POA (proof of address) check is required

disable_cross_check_by_bio
boolean
Default: false

Don't do cross check by name and birth date in POI document across organization.

disable_cross_check_by_photo
boolean
Default: false

Don't do cross check by photo of applicant across organization.

disable_verify_poa_country_match_with_poi
boolean
Default: false

Disable requirement that country in POA document should be match within country in POI document

countries
Array of strings <ISO 3166-1 ALPHA-2 code> [ items <ISO 3166-1 ALPHA-2 code > ]

List of allowed countries

allow_poi_manual_uploads
required
boolean
Default: false

Allow manual upload POI documents from files (now live photo)

allow_desktop
required
boolean
Default: false

Allow uploads throught desktop. False means only mobile allowed

ui_settings
object (UISettings)

ui settigns to customize SDK

object (ManualFieldsSettings)

Manual field settings

enabled
required
boolean
description
string
object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

object (ManualFieldSetting)

Manual field setting

Array of objects
object (LinkFinishScreenSettings)

Verification finish screen settings

enabled
required
boolean
object
aml_search_id
string <uuid>

AML search id operation

object (ManualFieldsValues)

Custom fields values

full_name
string
email
string
phone
string
country
string
dob
string

Date of birth.

gender
string
Enum: "M" "F"
citizenship
string
address
string
custom_fields
object (CustomFields)

Key - value object, values can be only strings

object (CustomFiles)

Mapping of custom field labels to uploaded document info

additional property
object

Custom file properties

document_id
required
string <UUID>
content_type
required
string

mime type

Response samples

Content type
application/json
{
  • "id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "status": "initial",
  • "documents": [
    • {
      • "document_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "document_type": "passport"
      }
    ],
  • "checks": {
    • "document_mrz": {
      • "data": {
        • "document_type": "Passport",
        • "country": "DE",
        • "name": "John",
        • "surname": "Doe",
        • "doc_number": "P-1234567890",
        • "nationality": "British",
        • "birth_date": "871224",
        • "sex": "M",
        • "expiry_date": "201224"
        },
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      },
    • "face_comparison": {
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      },
    • "poa": {
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      },
    • "liveness": {
      • "status": "pending",
      • "pending_documents": [
        • "passport"
        ],
      • "errors": [
        • {
          • "code": 1001,
          • "message": "document parsing failed"
          }
        ]
      }
    },
  • "created_at": "2023-07-18T15:32:13Z",
  • "completed_at": "2023-07-18T15:32:13Z",
  • "verification_url": "https://am.dataspike.io/VDBA1B2EA6A28A7D2",
  • "verification_url_id": "VDBA1B2EA6A28A7D2",
  • "country_code": "DE",
  • "expires_at": "2023-07-18T15:32:13Z",
  • "poi_data": {
    • "parsed_type": "passport",
    • "has_mrz": true,
    • "raw_mrz_type": "P",
    • "country": "DEU",
    • "full_name": "John Doe",
    • "name": "John",
    • "surname": "Doe",
    • "document_number": "P-1234567890",
    • "nationality": "DEU",
    • "birth_date": "1983-03-21",
    • "sex": "M",
    • "expiry_date": "2021-02-24",
    • "issue_date": "2021-02-24",
    • "pin": "string",
    • "card_number": "string",
    • "license_number": "string",
    • "license_type": "string",
    • "license_class": "string",
    • "cpf_number": "string",
    • "vin": "string",
    • "nin": "string",
    • "occupation": "string",
    • "polling_unit": "string",
    • "region": "string",
    • "restrictions": "string",
    • "height": "string",
    • "registration_date": "string",
    • "parents_names": "string",
    • "endorsements": "string"
    },
  • "is_sandbox": false,
  • "profile_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  • "settings": {
    • "poi_required": true,
    • "poi_allowed_documents": [
      • "passport"
      ],
    • "face_comparison_required": true,
    • "face_comparison_allowed_documents": [
      • "selfie"
      ],
    • "poa_required": false,
    • "disable_cross_check_by_bio": false,
    • "disable_cross_check_by_photo": false,
    • "disable_verify_poa_country_match_with_poi": false,
    • "countries": [
      • "FR"
      ],
    • "allow_poi_manual_uploads": false,
    • "allow_desktop": false,
    • "ui_settings": { },
    • "manual_field_settings": {
      • "enabled": true,
      • "description": "string",
      • "full_name": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "email": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "phone": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "country": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "dob": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "gender": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "citizenship": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "address": {
        • "enabled": true,
        • "caption": "string",
        • "order": 0
        },
      • "custom_fields": [
        • {
          • "label": "string",
          • "caption": "string",
          • "order": 0,
          • "options": {
            • "choices": [
              • "string"
              ],
            • "type": "select"
            }
          }
        ]
      },
    • "finish_screen_settings": {
      • "enabled": true,
      • "settings": {
        • "title": "string",
        • "main_text": "string",
        • "redirect_warning": "string",
        • "cta": "string",
        • "redirect_link": "string"
        }
      }
    },
  • "aml_search_id": "d358ace9-9e35-42cd-b8b7-837c1005d2f5",
  • "manual_fields": {
    • "full_name": "string",
    • "email": "string",
    • "phone": "string",
    • "country": "string",
    • "dob": "string",
    • "gender": "M",
    • "citizenship": "string",
    • "address": "string",
    • "custom_fields": { }
    },
  • "custom_files": {
    • "property1": {
      • "document_id": "507a6573-60ca-499e-8950-e2ca435dfe4f",
      • "content_type": "image/jpeg"
      },
    • "property2": {
      • "document_id": "507a6573-60ca-499e-8950-e2ca435dfe4f",
      • "content_type": "image/jpeg"
      }
    }
}

Get Verifications for an existing Applicant

Retrieve detailed information about an existing verification by providing existing Applicant ID as a URL parameter.

Authorizations:
ApiKeyAuth
path Parameters
applicant_id
required
string <uuid>
Example: 01827ed4-c928-7a3c-9a30-7ab7cc169d11

Fetch Verifications by Applicant ID

query Parameters
page
integer
Default: 0

Current page

limit
integer
Default: 0

Limit of returned items per page

Responses

Response Schema: application/json
Array of objects (VerificationInfo)

Object contains a list of an existing verifications

Array
id
required
string <uuid>

Id of created verification

applicant_id
required
string <uuid>

Id of applicant verification is linked to

status
required
string (VerificationStatus)
Enum: "initial" "pending" "in_progress" "verified" "failed" "canceled" "expired"

The First verification status is initial.

Second one is pending, when some documents are uploaded to verification or applicant of verification, but not all required documents are uploaded.

When all documents are uploaded and verification has been proceeded by api (https://docs.dataspike.io/api#tag/Verifications/operation/proceed-verification) or web sdk status becomes to in_progress.

After in_progress status can be both verified or failed depending on the verification result.

Transition to canceled status can be from any status if verification was canceled, except verified and failed.

Transition to expired status can be from any status if verification has expired, except verified, in_progress and failed.

Flow of status

Array of objects

List of prodived documents

required
object (CheckObject)

Object describes required checks and it`s current status

created_at
required
string <ISO-8601>

Verification creation timestamp

completed_at
string <ISO-8601>

Time of completion

verification_url
required
string

Verification url that can be provided to the end user to perform online verification

verification_url_id
required
string

Verification short id

country_code
string <ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes

expires_at
required
string <ISO-8601>

Verification expiration timestamp

object (PoiData)
is_sandbox
required
boolean
Default: false

Flag indicates that verification is created in sandbox env

profile_id
required
string <uuid>

Verification profile id

required
object (VerificationProfileSettings)

Verification profile settings

aml_search_id
string <uuid>

AML search id operation

object (ManualFieldsValues)

Custom fields values

object (CustomFiles)

Mapping of custom field labels to uploaded document info

has_next
boolean
Default: false

This property serves as an indicator of whether there is a next page available in the paginated results.

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "status": "initial",
      • "documents": [
        • {
          • "document_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
          • "document_type": "passport"
          }
        ],
      • "checks": {
        • "document_mrz": {
          • "data": {
            • "document_type": "Passport",
            • "country": "DE",
            • "name": "John",
            • "surname": "Doe",
            • "doc_number": "P-1234567890",
            • "nationality": "British",
            • "birth_date": "871224",
            • "sex": "M",
            • "expiry_date": "201224"
            },
          • "status": "pending",
          • "pending_documents": [
            • "passport"
            ],
          • "errors": [
            • {
              • "code": 1001,
              • "message": "document parsing failed"
              }
            ]
          },
        • "face_comparison": {
          • "status": "pending",
          • "pending_documents": [
            • "passport"
            ],
          • "errors": [
            • {
              • "code": 1001,
              • "message": "document parsing failed"
              }
            ]
          },
        • "poa": {
          • "status": "pending",
          • "pending_documents": [
            • "passport"
            ],
          • "errors": [
            • {
              • "code": 1001,
              • "message": "document parsing failed"
              }
            ]
          },
        • "liveness": {
          • "status": "pending",
          • "pending_documents": [
            • "passport"
            ],
          • "errors": [
            • {
              • "code": 1001,
              • "message": "document parsing failed"
              }
            ]
          }
        },
      • "created_at": "2023-07-18T15:32:13Z",
      • "completed_at": "2023-07-18T15:32:13Z",
      • "verification_url": "https://am.dataspike.io/VDBA1B2EA6A28A7D2",
      • "verification_url_id": "VDBA1B2EA6A28A7D2",
      • "country_code": "DE",
      • "expires_at": "2023-07-18T15:32:13Z",
      • "poi_data": {
        • "parsed_type": "passport",
        • "has_mrz": true,
        • "raw_mrz_type": "P",
        • "country": "DEU",
        • "full_name": "John Doe",
        • "name": "John",
        • "surname": "Doe",
        • "document_number": "P-1234567890",
        • "nationality": "DEU",
        • "birth_date": "1983-03-21",
        • "sex": "M",
        • "expiry_date": "2021-02-24",
        • "issue_date": "2021-02-24",
        • "pin": "string",
        • "card_number": "string",
        • "license_number": "string",
        • "license_type": "string",
        • "license_class": "string",
        • "cpf_number": "string",
        • "vin": "string",
        • "nin": "string",
        • "occupation": "string",
        • "polling_unit": "string",
        • "region": "string",
        • "restrictions": "string",
        • "height": "string",
        • "registration_date": "string",
        • "parents_names": "string",
        • "endorsements": "string"
        },
      • "is_sandbox": false,
      • "profile_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
      • "settings": {
        • "poi_required": true,
        • "poi_allowed_documents": [
          • "passport"
          ],
        • "face_comparison_required": true,
        • "face_comparison_allowed_documents": [
          • "selfie"
          ],
        • "poa_required": false,
        • "disable_cross_check_by_bio": false,
        • "disable_cross_check_by_photo": false,
        • "disable_verify_poa_country_match_with_poi": false,
        • "countries": [
          • "FR"
          ],
        • "allow_poi_manual_uploads": false,
        • "allow_desktop": false,
        • "ui_settings": { },
        • "manual_field_settings": {
          • "enabled": true,
          • "description": "string",
          • "full_name": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "email": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "phone": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "country": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "dob": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "gender": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "citizenship": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "address": {
            • "enabled": true,
            • "caption": "string",
            • "order": 0
            },
          • "custom_fields": [
            • {
              • "label": "string",
              • "caption": "string",
              • "order": 0,
              • "options": {
                • "choices": [
                  • "string"
                  ],
                • "type": "select"
                }
              }
            ]
          },
        • "finish_screen_settings": {
          • "enabled": true,
          • "settings": {
            • "title": "string",
            • "main_text": "string",
            • "redirect_warning": "string",
            • "cta": "string",
            • "redirect_link": "string"
            }
          }
        },
      • "aml_search_id": "d358ace9-9e35-42cd-b8b7-837c1005d2f5",
      • "manual_fields": {
        • "full_name": "string",
        • "email": "string",
        • "phone": "string",
        • "country": "string",
        • "dob": "string",
        • "gender": "M",
        • "citizenship": "string",
        • "address": "string",
        • "custom_fields": { }
        },
      • "custom_files": {
        • "property1": {
          • "document_id": "507a6573-60ca-499e-8950-e2ca435dfe4f"