Prevalidate bank contact details

curl --request POST \
  --url https://api.example.com/api/v1/user/contact/bank/validate \
  --header 'Content-Type: application/json' \
  --data '
{
  "bankType": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/user/contact/bank/validate"

payload = { "bankType": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({bankType: '<string>'})
};

fetch('https://api.example.com/api/v1/user/contact/bank/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "errors": [
    "<string>"
  ],
  "warnings": [
    "<string>"
  ],
  "lookups": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

user

contact

bank

validate

Prevalidate bank contact details

curl --request POST \
  --url https://api.example.com/api/v1/user/contact/bank/validate \
  --header 'Content-Type: application/json' \
  --data '
{
  "bankType": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/user/contact/bank/validate"

payload = { "bankType": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({bankType: '<string>'})
};

fetch('https://api.example.com/api/v1/user/contact/bank/validate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "errors": [
    "<string>"
  ],
  "warnings": [
    "<string>"
  ],
  "lookups": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Body

application/json

Request to prevalidate bank details before creating a contact.

bankType

string

required

country

string | null

bankName

string | null

iban

string | null

bic

string | null

routingNumber

string | null

accountNumber

string | null

accountHolderName

string | null

Beneficiary name the contact will carry. Checked against the 22-character NACHA receiver-name limit on ach; ignored on every other rail.

Response

Successful Response

Result of bank detail validation.

boolean

required

errors

string[]

warnings

string[]

lookups

Lookups · object

Overview

Generated API Reference

Prevalidate bank contact details

Body

Response