Create Screening

post

https://dev-api.zenta.app/screening-service/v1/public/screenings

Creates a new screening check for an Individual or Organization.

📘
Dependencies
Get Group ID: Call GET /public/companies first.
Get User ID: Call GET /public/users to retrieve the valid user IDs.
Get Account ID: Extract it from your URL or the previous endpoints.
Country Data: You must use the full object from GET /public/thirdparties/countries

Query Params

accountId

string

required

The account id of the user

Body Params

searchType

string

required

Required. Type of screening. Allowed values: INDIVIDUAL, ORGANIZATION

idNumber

string

Identification number (DNI, Tax ID).

groupIds

array of strings

required

Required. List of unique Group Identifiers where this screening belongs. How to get it: Use the response from GET /public/companies.

groupIds*

assigneeId

string

required

The User ID of the person responsible for reviewing this screening. How to get it: Use the response from GET /public/users.

screeningName

string

required

Internal reference name for this case file.

name

string

required

The main name to search for. For Individuals: Enter the First Name (e.g., "Antonio"). For Organizations: Enter the Company Name (e.g., "Repsol S.A.")

country

string

Must include full object (id, code, name) from /countries

middleName

string

[Individual Only] Middle name.

lastName

string

[Individual Only] Required if searchType is INDIVIDUAL.

gender

string

[Individual Only] Gender of the person. Allowed values: MALE, FEMALE

string

[Individual Only] Email address.

birthDate

string

[Individual Only] Format: YYYY-MM-DD.

nationality

string

[Individual Only] Nationality ISO Code.

matchLimit

int32

required

Optional. The maximum number of matches to return in the results. Recommendation: Send 0 to use the system default.

reporterId

string

required

Required. The User ID of the person creating the screening

Responses

📘Dependencies

200200

400400

404404

412412

500500

📘
Dependencies