Ad-hoc payee screening

POST

/v1/screen

Authorizations

• apiKey
• session

Request Body

object

name

string

>= 1 characters <= 500 characters

country

string

>= 1 characters <= 8 characters

wallet

object

address

required

string

>= 1 characters <= 256 characters

network

string

>= 1 characters <= 128 characters

Responses

200

Screening result

object

id

required

string

payee_key

required

string

result

required

string

Allowed values: clear potential_match match

matches

required

Array<object>

object

list

required

string

entry_id

required

string

name

required

string

score

required

number

matched_on

required

string

list_versions

required

object

key

additional properties

string

at

required

string

401

Not signed in

object

error

required

object

code

required

string

Example

invalid_request

message

required

string

details

Array

request_id

required

string

Example

req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

403

Forbidden

object

error

required

object

code

required

string

Example

invalid_request

message

required

string

details

Array

request_id

required

string

Example

req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W