POST
Create screening entity

Authorizations

x-api-key
string
header
required

Headers

x-tenant
string
required

Tenant identifier

Query Parameters

withMatches
boolean
default:false

Option to include matches in the response. Max of 250 Matches. Default is false.

withCapital
boolean
default:false
withKyc
boolean
default:false

Option to include Kyc details in the response. Default is false.

allowAutoOnboarding
boolean
default:false

Boolean to indicate whether automatic onboarding is allowed if the entity does not have public cases, local cases, or mentioned in news media

Body

application/json
type
enum<string>
required

Entity type (individual vs organization)

Available options:
Individual,
Organization
status
enum<string>
required

Entity status

Available options:
Active,
Blocked,
Deactivated,
Deceased
nameEn
string

Full name in English. Either nameEn or nameAr must be provided

Example:

"John Michael Doe"

nameAr
string

Full name in Arabic. Either nameEn or nameAr must be provided

Example:

"جون ميخائيل دو"

gender
enum<string>

Entity gender

Available options:
Male,
Female,
NotSpecified
email
string

Email address of the entity

Example:

"john.doe@example.com"

countryCode
string

Country code for phone number (numeric digits as string, e.g., "966" for Saudi Arabia). If provided, phoneNumber must also be provided. If phoneNumber is provided, countryCode must also be provided.

Example:

"966"

phoneNumber
string

Phone number. If provided, countryCode must also be provided. If countryCode is provided, phoneNumber must also be provided.

Example:

"501234567"

accountOpenDate
string<date-time>

Account opening date (YYYY-MM-DD)

Example:

"2025-06-15"

dobGregorian
string

Date of birth (Gregorian, YYYY-MM-DD)

Example:

"1990-05-20"

dobHijri
string

Date of birth (Hijri, YYYY-MM-DD). Converted to Gregorian internally.

Example:

"1410-10-15"

dateOfIncorporationGregorian
string

Entity incorporation date (Gregorian, YYYY-MM-DD)

Example:

"2005-09-30"

dateOfIncorporationHijri
string

Entity incorporation date (Hijri, YYYY-MM-DD). Converted to Gregorian internally.

Example:

"1426-08-20"

nationalityCode
string

Nationality code (ISO 3166-1 alpha-2)

Example:

"SA"

crmId
string

A string identifier from your organization's system (such as a database-generated ID) that you provide so it can also be stored and referenced in our database

Example:

"550e8400-e29b-41d4-a716-446655440000"

tagIds
string[]

Tags to apply. On update, replaces the existing tags entirely; omit the field to leave them untouched.

identities
object[]

Response

Success

data
object
required

Created entity

quota
object
required

Quota information

creationStatus
enum<string>
Available options:
Created,
Invalid,
Existing