Send verification payee request

post

https://sandbox.numeral.io/v1/payee_verification_requests

Send a request to verify your payee's information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

scheme

string

enum

required

The scheme on which the request will be sent. Only vop is supported today.

Allowed:

payee_identification_type

string

enum

required

The type of identification used in the request. See Supported identification type for more information.

payee_identification

string

required

The identification of the payee. For example, if payee_identification_type = name, then you should fill the name of the payee here.

payee_account_number

string

required

The account number of the payee. When scheme = vop, must be an IBAN.

payee_additional_information

string

length ≤ 140

Additional information about the payee.

requesting_agent_bank_code

string

The BIC11 you want to use to send your request. Must be one of the BIC11 configured in Numeral for your company.

metadata

object

Additional client data in JSON format. See Metadata.

Headers

Idempotency-Key

string

An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully created payee verification request

400Validation error.

500Internal server error.