Sanction Screening Service

This request will execute Sanction Screening Service.

Before making the request, please ensure you meet the following prerequisites:

  1. Visit Licensing to see how to get your credentials.

  2. For the "sanction/screen" endpoint on orchestration layer.

  3. This API allows you to perform screening checks for various data types, such as email, phone, IP, BIN, device, name, and AML, using the providers FIDO and SEON.

  4. The endpoint provides details about the screened data and the results based on the screening configuration.

Checkout acceptable header values to see what values we accept for each header.

Replace https://soma.sybrin.com/ with relevant base URL.

Sanction Screening Service

POST api/v1/sanction/screen

Headers

NameTypeDescription

Authorization*

String

Authorization required for endpoint api/Authentication/GetAuthToken

FidoAPIKey*

String

Fido API key (Required if fido screening is used)

SeonAPIKey*

String

Seon API Key (Required if seon screening is used)

Request Body

NameTypeDescription

enable_email_screening

Bool

Enables email screening requires email configuration if set to true (default is false)

name_configuration

Object

Required if name screening is enabled.

-provider: 3rd party provider of the screening (for name screening : FIDO| PIPL supported)

-input (Generic type that is based on provider)

-Please refer to https://docs.fido.id/reference/fido-name for fido

bin_configuration

Object

Required if bin screening is enabled.

-provider: 3rd party provider of the screening (for bin screening : SEON supported)

-input (Generic type that is based on provider)

-Please refer to https://docs.seon.io/api-reference/bin-api

ip_configuration

Object

Required if ip screening is enabled.

-provider: 3rd party provider of the screening (for ip screening : SEON | FIDO supported)

-input (Generic type that is based on provider)

-Please refer to https://docs.seon.io/api-reference/ip-api for seon

-Please refer to https://docs.fido.id/reference/fido-ip for fido

phone_configuration

Object

Required if phone screening is enabled.

-provider: 3rd party provider of the screening (for phone screening : SEON | FIDO |PIPL supported)

-input (Generic type that is based on provider)

-Please refer to https://docs.seon.io/api-reference/phone-api#phone-api-request for seon

-Please refer to https://docs.fido.id/reference/fido-phone for fido

email_configuration

Object

Required if email screening is enabled.

-provider: 3rd party provider of the screening (for email screening : SEON | FIDO| PIPL supported)

-input (Generic type that is based on provider) -Please refer to https://docs.seon.io/api-reference/email-api#email-api-request for seon

-Please refer to https://docs.fido.id/reference/fido-email for fido

enable_aml_screening

Bool

Enables aml (anti money laundering) screening requires aml configuration if set to true (default is false)

enable_name_screening

Bool

Enables name screening requires name configuration if set to true (default is false)

enable_device_screening

Bool

Enables device screening requires device configuration if set to true (default is false)

enable_bin_screening

Bool

Enables bin screening requires bin configuration if set to true (default is false)

enable_ip_screening

Bool

Enables ip screening requires ip configuration if set to true (default is false)

enable_phone_screening

Bool

Enables phone screening requires phone configuration if set to true (default is false)

aml_configuration

Object

Required if aml screening is enabled.

-provider: 3rd party provider of the screening (for aml screening : SEON supported)

-input (Generic type that is based on provider)

-Please refer to https://docs.seon.io/api-reference/aml-api#aml-api-request for seon

device_configuration

Object

Required if device screening is enabled.

-provider: 3rd party provider of the screening (for device screening: FIDO supported)

-input (Generic type that is based on provider)

-Please refer to https://docs.fido.id/reference/fido-device for fido

enable_identity_screening

Bool

Enables identity screening requires identity configuration if set to true (default is false)

identity_configuration

Object

Required if name screening is enabled

-provider: 3rd party provider of the screening (for identity screening : PIPL supported)

-input (Generic type that is based on provider)