API (v1.1.7)

Download OpenAPI specification:Download

Everything you need to get started with Sora ID.

API Keys

Login Sessions

Create Login Session

Create a login session.

SecurityAuthorization_Bearer
Request
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

host
string (Host)
Request Body schema: application/json
required
auth_type
required
string (Auth Type)

Method to authenticate the user with if WebAuthn is not available. One of sms or email.

email
string (Email)

Email collected from the user.

phone
string (Phone)

Phone number collected from the user.

redirect_url
string (Redirect URL)

If present, users will be redirected to this url upon successful login.

second_factor
string (Second Factor)

If set to totp, we will require the user also either logs in with or registers a time-based OTP, such as those in an authenticator app.

locale
string (Locale)

Locale to use for the user interface and any communication with the end-user. This will override any locale supplied by the user.

is_webview
boolean (Is Webview)
Default: false

Set to true if using the Webview integration method.

project_id
string (Project Id)

The project ID to use for this session (when not using the default configuration).

object (Custom Fields)

Custom fields specified by you as key-value pairs.

verified_phone_type
string (Verified Phone Type)

If you've already authenticated the user's phone number, use this field to indicate how you've done so. Supported values are otp and whatsapp. Required to skip directly to identity verification without OTP/WebAuthn verification.

verified_phone_time
integer (Verified Phone Time)

A unix timestamp representing the time the user's phone number was verified. Required when verified_phone_type is set to otp.

verified_email_type
string (Verified Email Type)

If you've already authenticated the user's email, use this field to indicate how you've done so. Currently the only supported value is otp. Required to skip directly to identity verification without OTP/WebAuthn verification.

verified_email_time
integer (Verified Email Time)

A unix timestamp representing the time when the user's email address was verified. Required when verified_email_type is set to otp.

Responses
200

Returns a Login Session object.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/login_sessions
Request samples
application/json
{
  • "auth_type": "sms"
}
Response samples
application/json
{
  • "id": "string",
  • "object_name": "login_session",
  • "authenticated": true,
  • "authentication_methods": [ ],
  • "activated_authentication_methods": [ ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "ip": [ ],
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": true,
  • "user_id": "string",
  • "project_id": "string",
  • "custom_fields": {
    }
}

List Login Sessions

SecurityAuthorization_Bearer
Request
query Parameters
page_size
integer (Page Size)
Default: 25

Number of records per page.

page
integer (Page)
Default: 1

Page number of the current page.

sort_descending
boolean (Sort Descending)
Default: true

Whether to sort in descending (True) or ascending (False) order. By default, sorts descending.

sort_by
string (SortByOptions)
Default: "created_at"

Property to sort by. "created_at" by default.

Enum: "user_id" "status" "created_at" "updated_at" "completed_at" "expires_at" "creator_email" "first_name" "middle_name" "last_name" "second_family_name" "email" "phone" "user_created"
search_term
string (Search Term)
Default: ""

Search term.

header Parameters
content-type
string (Content-Type)

Must be application/json

host
string (Host)
authorization
string (Authorization)

Bearer

Responses
200

Returns a list of Login Session objects.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/login_sessions
Request samples
Response samples
application/json
{
  • "logins": [
    ],
  • "links": {}
}

Update Login Session

SecurityAuthorization_Bearer
Request
path Parameters
id
required
string (ID)

Login Session ID

header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Request Body schema: application/json
required
otp
string <OTP> (OTP)

The OTP collected from the user.

Responses
200

Returns a Login Session object.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/login_sessions/{id}
Request samples
application/json
{
  • "otp": "123456"
}
Response samples
application/json
{
  • "id": "string",
  • "object_name": "login_session",
  • "authenticated": true,
  • "authentication_methods": [ ],
  • "activated_authentication_methods": [ ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "ip": [ ],
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": true,
  • "user_id": "string",
  • "project_id": "string",
  • "custom_fields": {
    }
}

Get Login Session

SecurityAuthorization_Bearer
Request
path Parameters
id
required
string (ID)

Login Session ID

header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Responses
200

Returns a Login Session object.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/login_sessions/{id}
Request samples
Response samples
application/json
{
  • "id": "string",
  • "object_name": "login_session",
  • "authenticated": true,
  • "authentication_methods": [ ],
  • "activated_authentication_methods": [ ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "ip": [ ],
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": true,
  • "user_id": "string",
  • "project_id": "string",
  • "custom_fields": {
    }
}

Send Login Session OTP via Backend

SecurityAuthorization_Bearer
Request
path Parameters
id
required
string (ID)

Login Session ID

header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Request Body schema: application/json
resend
boolean (Resend)
Default: false

Set this field to True when this is not the first OTP sent to the user

Responses
200

Returns a Login Session object.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/login_sessions/{id}/send_otp
Request samples
application/json
{
  • "resend": false
}
Response samples
application/json
{
  • "id": "string",
  • "object_name": "login_session",
  • "authenticated": true,
  • "authentication_methods": [ ],
  • "activated_authentication_methods": [ ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "ip": [ ],
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": true,
  • "user_id": "string",
  • "project_id": "string",
  • "custom_fields": {
    }
}

Add Custom Fields to Login Session

SecurityAuthorization_Bearer
Request
path Parameters
id
required
string (ID)

Login Session ID

header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Request Body schema: application/json
required
required
object (Custom Fields)

Custom fields specified by you as key-value pairs.

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/login_sessions/{id}/custom_fields
Request samples
application/json
{
  • "custom_fields": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "object_name": "login_session",
  • "authenticated": true,
  • "authentication_methods": [ ],
  • "activated_authentication_methods": [ ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "ip": [ ],
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": true,
  • "user_id": "string",
  • "project_id": "string",
  • "custom_fields": {
    }
}

Verification Sessions

Create Verification Session

VerificationOptions -> Verification

SecurityAuthorization_Bearer
Request
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

host
string (Host)
Request Body schema: application/json
redirect_url
string (Redirect URL)

If present, users will be redirected to this url upon successful verification.

auth_type
string (Authorization Type)
Default: "sms"

Method to authenticate the user with if WebAuthn is not available. One of sms or email.

phone
string (Phone)

Phone number collected from the user.

email
string (Email)

Email collected from the user.

login_id
string (Login ID)

The ID of the login session used to authenticate the user. This is used to skip the authentication steps in verification sessions if the user was previously authenticated.

second_factor
string (Second Factor)

Factor to use for 2FA. totp and None are the only supported values right now if the user does not have webauthn.

verified_phone_type
string (Verified Phone Type)

If you've already authenticated the user's phone number, use this field to indicate how you've done so. Supported values are otp and whatsapp. Required to skip directly to identity verification without OTP/WebAuthn verification.

verified_phone_time
integer (Verified Phone Time)

A unix timestamp representing the time the user's phone number was verified. Required when verified_phone_type is set to otp.

verified_email_type
string (Verified Email Type)

If you've already authenticated the user's email, use this field to indicate how you've done so. Currently the only supported value is otp. Required to skip directly to identity verification without OTP/WebAuthn verification.

verified_email_time
integer (Verified Email Time)

A unix timestamp representing the time when the user's email address was verified. Required when verified_email_type is set to otp.

locale
string (Locale)

Locale to use for the user interface and any communication with the end-user. This will override any locale supplied by the user.

object (Identity Info)

Identity info you have collected about the user to be used in this verification session.

is_webview
boolean (Is Webview)
Default: false

Set to true if using the Webview integration method.

send_creator_email
boolean (Send Creator Email)
Default: true
collect_second_family_name
boolean (Collect Second Family Name)

Allow the user to enter their second family name in a separate field.

project_id
string (Project Id)

The project ID to use for this session (when not using the default configuration).

object (Custom Fields)

Custom fields specified by you as key-value pairs.

Responses
200

Returns a Verification Session object.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/verification_sessions
Request samples
application/json
{
  • "auth_type": "sms",
  • "is_webview": false,
  • "send_creator_email": true,
  • "sandbox": false
}
Response samples
application/json
{
  • "id": "string",
  • "object_name": "verification_session",
  • "authenticated": true,
  • "authentication_methods": [
    ],
  • "activated_authentication_methods": [ ],
  • "checks": [
    ],
  • "collected_traits": [
    ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "fields_to_collect": [ ],
  • "ip": [ ],
  • "is_data_granted": true,
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": false,
  • "user_id": "string",
  • "traits": {
    },
  • "verified_info": {
    },
  • "project_id": "string",
  • "report_id": "string",
  • "custom_fields": {
    }
}

List Verification Sessions

SecurityAuthorization_Bearer
Request
query Parameters
page_size
integer (Page Size)
Default: 25

Number of records per page.

page
integer (Page)
Default: 1

Page number of the current page.

sort_descending
boolean (Sort Descending)
Default: true

Whether to sort in descending (True) or ascending (False) order. By default, sorts descending.

sort_by
string (SortByOptions)
Default: "created_at"

Property to sort by. "created_at" by default.

Enum: "user_id" "status" "created_at" "updated_at" "completed_at" "expires_at" "creator_email" "first_name" "middle_name" "last_name" "second_family_name" "email" "phone" "user_created"
search_term
string (Search Term)
Default: ""

Search term.

header Parameters
content-type
string (Content-Type)

Must be application/json

host
string (Host)
authorization
string (Authorization)

Bearer

Responses
200

Returns a list of Verification Session objects.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/verification_sessions
Request samples
Response samples
application/json
{
  • "verifications": [
    ],
  • "links": {}
}

Update Verification Session

⚠️ The base URL is different for this endpoint!

Please use https://secure.soraid.com as the base URL for this endpoint. Requests sent to secure.soraid.com are automatically tokenized before hitting our servers, ensuring your users' sensitive PII never sees our backend.

SecurityAuthorization_Bearer
Request
path Parameters
id
required
string (ID)

Verification Session ID

header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Request Body schema: application/json
required
first_name
string (First Name) <= 100 characters

The user's first name.

middle_name
string (Middle Name) <= 100 characters

The user's middle name. Separate multiple middle names with spaces.

last_name
string (Last Name) <= 100 characters

The user's last name.

second_family_name
string (Second Family Name) <= 100 characters

The user's second last name.

full_last_name
string (Full Last Name)

The user's full last name. Includes second last name if applicable.

dob_day
integer (Date of Birth Day)

The day of the user's date of birth (first day of the month is 1)

dob_month
integer (Date of Birth Month)

The month of the user's date of birth (January is 1)

dob_year
integer (Date of Birth Year)

The year of the user's date of birth

ssn4
string (SSN4)

The last 4 digits of the user's social security number.

ssn9
string (SSN9)

The user's full social security number.

otp
string (OTP)

The OTP collected from the user.

phone
string (Phone)

The user's phone number.

email
string (Email)

The user's email address.

address_line1
string (Address Line1) <= 500 characters

The user's street address.

address_line2
string (Address Line2) <= 500 characters

The second line of the user's address, such as their apartment, suite or building number.

address_city
string (Address City) <= 500 characters

The city of the user's address.

address_state
string (Address State) <= 50 characters

The state of the user's address.

address_postal_code
string (Address Postal Code) <= 50 characters

The postal code of the user's address.

address_country
string (Address Country) <= 50 characters

The country alpha-3 code of the user's address. Refer to the ISO 3166 international standard. Only required for non-US addresses.

document_front
string (Document Front)

The image of the front of the user's document. Could be a driver's license, passport, or government identification card.

document_back
string (Document Back)

The image of the back of the user's document (when appropriate). Could be a driver's license or government identification card.

document_type
string (Document Type)

The type of the user's document. May be one of 'drivers_license', 'paper_passport', 'passport_card', or 'id_card'. Refer to https://soraid.redoc.ly/#tag/Supported-Document-Types

document_country_iso3
string (Document Country Iso3)

The issuing country's alpha-3 code of the user's document. Refer to the ISO 3166 international standard.

allow_bad_address
boolean (Allow Bad Address)
Default: true

Whether to allow addresses that fail USPS validation.

object (Citizenship Info)

Self-reported citizenship and identifying information existence (user has SSN, ITIN).

identification_number
string (Identification Number)

Non-US national identification number. For example, Brazilian CPF. If you are submitting an SSN or ITIN, use the ssn9 field. Please contact support if you'd like to use this field.

identification_type
string (Identification Type)

Specifies the type of national identification number submitted in the identification_number field, for example, BRA_CPF. This field is required if you submit an identification_number. Please see the Supported National Identification Number Types table for a list of accepted values.

force_fail
boolean (Force Fail)
Default: false

Whether to force a failed verification. This is used in sandbox mode.

Responses
200

Returns a Verification Session object.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/verification_sessions/{id}
Request samples
application/json
{
  • "first_name": "Gavin",
  • "last_name": "Belson",
  • "ssn4": "0001"
}
Response samples
application/json
{
  • "id": "string",
  • "object_name": "verification_session",
  • "authenticated": true,
  • "authentication_methods": [
    ],
  • "activated_authentication_methods": [ ],
  • "checks": [
    ],
  • "collected_traits": [
    ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "fields_to_collect": [ ],
  • "ip": [ ],
  • "is_data_granted": true,
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": false,
  • "user_id": "string",
  • "traits": {
    },
  • "verified_info": {
    },
  • "project_id": "string",
  • "report_id": "string",
  • "custom_fields": {
    }
}

Get Verification Session

SecurityAuthorization_Bearer
Request
path Parameters
id
required
string (ID)

Verification Session ID

header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Responses
200

Returns a Verification Session object.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/verification_sessions/{id}
Request samples
Response samples
application/json
{
  • "id": "string",
  • "object_name": "verification_session",
  • "authenticated": true,
  • "authentication_methods": [
    ],
  • "activated_authentication_methods": [ ],
  • "checks": [
    ],
  • "collected_traits": [
    ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "fields_to_collect": [ ],
  • "ip": [ ],
  • "is_data_granted": true,
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": false,
  • "user_id": "string",
  • "traits": {
    },
  • "verified_info": {
    },
  • "project_id": "string",
  • "report_id": "string",
  • "custom_fields": {
    }
}

Send Verification Session OTP via Backend

SecurityAuthorization_Bearer
Request
path Parameters
id
required
string (ID)

Verification Session ID

header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Request Body schema: application/json
resend
boolean (Resend)
Default: false

Set this field to True when this is not the first OTP sent to the user

Responses
200

Returns a Verification Session object.

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/verification_sessions/{id}/send_otp
Request samples
application/json
{
  • "resend": false
}
Response samples
application/json
{
  • "id": "string",
  • "object_name": "verification_session",
  • "authenticated": true,
  • "authentication_methods": [
    ],
  • "activated_authentication_methods": [ ],
  • "checks": [
    ],
  • "collected_traits": [
    ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "fields_to_collect": [ ],
  • "ip": [ ],
  • "is_data_granted": true,
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": false,
  • "user_id": "string",
  • "traits": {
    },
  • "verified_info": {
    },
  • "project_id": "string",
  • "report_id": "string",
  • "custom_fields": {
    }
}

Add Custom Fields to Verification Session

SecurityAuthorization_Bearer
Request
path Parameters
id
required
string (ID)

Verification Session ID

header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Request Body schema: application/json
required
required
object (Custom Fields)

Custom fields specified by you as key-value pairs.

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/verification_sessions/{id}/custom_fields
Request samples
application/json
{
  • "custom_fields": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "object_name": "verification_session",
  • "authenticated": true,
  • "authentication_methods": [
    ],
  • "activated_authentication_methods": [ ],
  • "checks": [
    ],
  • "collected_traits": [
    ],
  • "completed_at": 0,
  • "created_at": 0,
  • "email": "string",
  • "expires_at": 0,
  • "fields_to_collect": [ ],
  • "ip": [ ],
  • "is_data_granted": true,
  • "phone": "string",
  • "redirect_url": "string",
  • "status": "success",
  • "token": "string",
  • "updated_at": 0,
  • "user_agent": [ ],
  • "user_created": false,
  • "user_id": "string",
  • "traits": {
    },
  • "verified_info": {
    },
  • "project_id": "string",
  • "report_id": "string",
  • "custom_fields": {
    }
}

Reports (beta)

Create report configuration

Create a report configuration that can be used to create reports on users. A report configuration specifies which watchlists to check and how often to check them.

SecurityAuthorization_Bearer
Request
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Request Body schema: application/json
required
name
required
string (Name)

Name of this report configuration

watchlists
required
Array of strings (Watchlists)

List of watchlists. Must be non-empty. List of valid watchlists can be found in the "Supported Watchlists" section.

update_frequency
required
integer (Update Frequency)

How often to update this report configuration, in seconds. Must be greater than one day (86400 seconds).

set_default
boolean (Set Default)
Default: false

If True, sets this to be your default configuration.

score_threshold
number (Score Threshold)
Default: 0.9

How closely a name must match to trigger a watchlist hit. Strictest is 1, loosest is 0. We recommend 0.9 and set it to this by default.

require_matching_country
boolean (Require Matching Country)
Default: false

If True, only hits with a matching country of residence will appear.

require_matching_dob_year
boolean (Require Matching Dob Year)
Default: false

If True, only hits with a matching year of birth will appear.

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/reports/report_config
Request samples
application/json
{
  • "name": "string",
  • "watchlists": [
    ],
  • "update_frequency": 0
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "watchlists": [
    ],
  • "created_at": "string",
  • "is_default": true,
  • "update_frequency": 0
}

List report configurations

See all report configs you have created

SecurityAuthorization_Bearer
Request
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/reports/report_config
Request samples
Response samples
application/json
[
  • {
    }
]

View report configuration

View the specifics of a report config you have created.

SecurityAuthorization_Bearer
Request
path Parameters
report_config_id
required
string (Report Config Id)
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/reports/report_config/{report_config_id}
Request samples
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "watchlists": [
    ],
  • "created_at": "string",
  • "is_default": true,
  • "update_frequency": 0
}

Create report on a user

Start watching a user's status on the watchlists specified in your report config.

SecurityAuthorization_Bearer
Request
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Request Body schema: application/json
required
user_id
required
string (User Id)

ID of the user to create a report on

report_config_id
string (Report Config Id)

ID of the report configuration to use. If not provided, your default report configuration will be used.

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/reports/report
Request samples
application/json
{
  • "user_id": "string"
}
Response samples
application/json
{
  • "report_id": "string",
  • "user_id": "string",
  • "status": "match_found",
  • "first_report_created_at": 0,
  • "updated_at": 0,
  • "lists_being_monitored": [
    ],
  • "matches": {
    }
}

Create a report for a new user

Create a report for a user without a previously created VerificationSession. If a VerificationSession has been created, please use the /reports/report endpoint.

SecurityAuthorization_Bearer
Request
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Request Body schema: application/json
required
required
object (Report on New User Info Model)
report_config_id
string (Report Config Id)

ID of the report configuration to use. If not provided, your default report configuration will be used.

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

post/reports/new_user
Request samples
application/json
{
  • "user_info": { }
}
Response samples
application/json
{
  • "report_id": "string",
  • "user_id": "string",
  • "status": "match_found",
  • "first_report_created_at": 0,
  • "updated_at": 0,
  • "lists_being_monitored": [
    ],
  • "matches": {
    }
}

View status of report

View the current status of a report you have created (i.e., whether this user has shown up on any watchlists). This status is guaranteed to be updated within the update_frequency set in the report configuration.

SecurityAuthorization_Bearer
Request
path Parameters
report_id
required
string (Report Id)
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/reports/report/{report_id}
Request samples
Response samples
application/json
{
  • "report_id": "string",
  • "user_id": "string",
  • "status": "match_found",
  • "first_report_created_at": 0,
  • "updated_at": 0,
  • "lists_being_monitored": [
    ],
  • "matches": {
    }
}

Stop monitoring a user and delete the report on them.

SecurityAuthorization_Bearer
Request
path Parameters
report_id
required
string (Report Id)
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

delete/reports/report/{report_id}
Request samples
Response samples
application/json
null

View all updated reports since given timestamp

View a list of report ID's corresponding to reports that have had a status change since the since query parameter.

SecurityAuthorization_Bearer
Request
query Parameters
since
required
number (Since)

A unix timestamp. Reports that have had a status change since this parameter will be returned.

header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/reports/updates
Request samples
Response samples
application/json
[
  • "string"
]

Find a report by the user ID of the user being monitored

SecurityAuthorization_Bearer
Request
path Parameters
user_id
required
string (User Id)
header Parameters
content-type
string (Content-Type)

Must be application/json

authorization
string (Authorization)

Bearer

Responses
200

Successful Response

400

Bad Request

401

Unauthorized

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

get/reports/report/by_user/{user_id}
Request samples
Response samples
application/json
{
  • "report_id": "string",
  • "user_id": "string",
  • "status": "match_found",
  • "first_report_created_at": 0,
  • "updated_at": 0,
  • "lists_being_monitored": [
    ],
  • "matches": {
    }
}

Status Descriptions

Supported Identity Checks

Supported Document Types

Supported Watchlists

Supported National Identification Number Types