Skip to main content
POST
/
api
/
v1
/
accounts
/
utils
/
parse-iban
Parse IBAN from plain text
curl --request POST \
  --url https://api.hevn.finance/api/v1/accounts/utils/parse-iban \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>"
}
'
{
  "iban": "<string>",
  "currency": "<string>",
  "accountHolderName": "<string>",
  "bankAddress": "<string>",
  "bankName": "<string>",
  "bic": "<string>",
  "label": "<string>",
  "relationship": "self"
}

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

Body

application/json

Request to parse plain text and extract IBAN data.

​
text
string
required
Required string length: 10 - 5000

Response

Successful Response

SEPA account data parsed from free-form text.

​
iban
string
required
Required string length: 15 - 34
​
country
enum<string>
required

ISO 3166-1 alpha-2 country codes.

Available options:
AF,
AX,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BQ,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
CV,
KH,
CM,
CA,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CW,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
SZ,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IM,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MK,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
SS,
ES,
LK,
SD,
SR,
SJ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
​
currency
string
required
Required string length: 3
​
accountHolderName
string
required
Required string length: 1 - 255
​
bankAddress
string | null
Required string length: 1 - 512
​
bankName
string | null
Required string length: 1 - 255
​
bic
string | null
Required string length: 8 - 11
​
label
string | null
Required string length: 1 - 255
​
relationship
enum<string>
default:self

Relationship of the account holder to the customer.

Available options:
self,
employee,
independent_contractor,
vendor,
supplier,
subsidiary,
affiliate,
merchant,
partner,
customer,
landlord,
family,
other