Skip to main content
POST
/
api
/
v1
/
bank
/
{rail}
/
pre-approve
Pre-approve a bank rail
curl --request POST \
  --url https://api.hevn.finance/api/v1/bank/{rail}/pre-approve \
  --header 'Authorization: Bearer <token>'
{
  "kycUrl": "<string>",
  "kycStatus": "not_started",
  "requirePhoneNumber": false,
  "requireAddress": false,
  "requireKyb": false
}

Authorizations

​
Authorization
string
header
default:Bearer <token>
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-key
string | null

Path Parameters

​
rail
enum<string>
required

Bank account route: provider rail + bank id ({rail}-{bank}).

Available options:
uaefts_named-zand,
ach_pooled-hsbc,
ach_named-citi,
ach_named-jpmorgan_chase,
ach_named-cfsb,
fedwire_pooled-hsbc,
fedwire_pooled-jpmorgan_chase,
fedwire_pooled-cfsb,
fedwire_named-hsbc,
fedwire_named-citi,
fedwire_named-jpmorgan_chase,
fedwire_named-cfsb,
sepa_pooled-zen,
sepa_named-zen,
swift_pooled-hsbc,
swift_named-hsbc

Response

Successful Response

Read-only KYC info for a rail. Does not mutate Bank rows.

​
kycUrl
string | null
​
kycStatus
enum<string>
default:not_started

KYC verification status.

Available options:
not_started,
requested,
incorporating,
pending,
under_review,
in_review,
approved,
rejected
​
requirePhoneNumber
boolean
default:false
​
requireAddress
boolean
default:false
​
requireKyb
boolean
default:false