Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
payee-verification-requests

List payee verification requests

List and filter payee verification requests.

get/payee_verification_requests

Query parameters

limitinteger
starting_afterstring

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

Filter by creation date from.

end_datestring date

Filter by creation date to.

status'created' | 'completed' | 'failed' | 'received'

Filter by status.

direction'outgoing' | 'incoming'

Filter by direction.

scheme'vop'

Filter by scheme.

payee_identification_typestring

The payee identification type used in the payee verification request.

payee_identificationstring

The payee identification used in the payee verification request.

payee_account_numberstring

The payee account number used in the payee verification request.

requesting_agent_bank_codestring

The requesting agent of the payee verification request.

responding_agent_bank_codestring

The responding agent of the payee verification request.

matching_result'match' | 'close_match' | 'no_match' | 'impossible_match'

The matching result agent of the payee verification request.

internal_account_idstring uuid

The ID of the internal account of the payee verification request.

Response

List of filtered payee verification requests

Example response

{
  "records": [
    {
      "id": "c39d1eff-c5ed-4197-8f24-28a68bd0eee6",
      "idempotency_key": "8A2gcC",
      "object": "payee_verification_request",
      "status": "completed",
      "status_details": "Some details about the status.",
      "failure_code": "business_error",
      "direction": "incoming",
      "scheme": "vop",
      "request": {
        "payee_identification_type": "name",
        "payee_identification": "John Doe",
        "sent_identification": "John Doe",
        "payee_account_number": "FR5012739000308682265435N36",
        "additional_information": "Account 123-ABC",
        "requesting_agent_bank_code": "SOMEBICXXX",
        "responding_agent_bank_code": "BANKITPPXXX"
      },
      "matching_result": "match",
      "matching_details": {
        "cleaned_identification": "John Doe",
        "retrieved_identification": "John Doe",
        "retrieved_identifications": [
          "John Doe",
          "J. Doe",
          "John M. Doe"
        ],
        "internal_account_id": "c39d1eff-c5ed-4197-8f24-28a68bd0eee6",
        "matching_score": 100,
        "distance": "levenshtein",
        "match_threshold": 90,
        "close_match_threshold": 75
      },
      "scheme_data": {
        "scheme_request_id": "c3d79e5a-2058-4301-8b36-353cb9eb0ca5",
        "request_timestamp": "2025-01-26T13:51:10Z",
        "response_timestamp": "2025-01-26T13:51:15Z"
      },
      "response_received_at": "2025-01-26T13:51:15Z",
      "initiated_at": "2025-01-26T13:51:10Z",
      "metadata": {
        "property_a": true,
        "property_b": "false"
      },
      "created_at": "2025-01-01T12:00:00Z"
    }
  ]
}