API reference

Simulate incoming payee verification request

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

Simulate an incoming payee verification request for testing and development purposes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The scheme of the request you want to simulate. Only vop is supported.

Allowed:
string
enum
required

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

string
required

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

string
required

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

string
length ≤ 140

Additional information about the payee.

string

The BIC of the requesting agent sending the request in your simulation.

string
enum

The matching algorithm you want to use to respond to this request. Supported values are levenshtein and jaro-winkler.

Allowed:
integer

The matching score above which you want the matching result to be match.

integer

The matching score below which you want the matching result to be close_match. When matching score is between min_score_match and min_score_close_match, matching result will be close_match.

string
required

The BIC of the responding agent receiving the request in your simulation.

metadata
object

Additional client data in JSON format. See Metadata.

Responses

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago