Skip to main content
POST
/
api
/
v1
/
user
/
contact
Create contact
curl --request POST \
  --url https://api.hevn.finance/api/v1/user/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "<string>",
  "email": "<string>",
  "iban": {
    "bankName": "<string>",
    "ibanNumber": "<string>",
    "bankAddress": "<string>",
    "currency": "<string>",
    "accountHolderFirstName": "<string>",
    "accountHolderLastName": "<string>",
    "accountHolderBusinessName": "<string>",
    "accountHolderAddress": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "paymentReference": "<string>",
    "accountType": "sepa",
    "bic": "<string>"
  },
  "address": {
    "streetAddress": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  }
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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 create a contact.

​
name
string
default:""
Required string length: 1 - 200
​
currency
string | null

Currency override

Required string length: 3 - 4
​
email
string | null
​
crypto
ContactCryptoInput · object

Crypto contact input.

​
account
OnchainAccountInput · object

Onchain wallet contact input.

​
iban
IBANAccountDetails · object

IBAN (SEPA) external account.

​
address
UserAddress · object

Address schema for user.

Canonical field names: street_address, address_line_2, city, state, country, zip. Accepts legacy Align/IBAN field names (street_line_1, street_line_2, postal_code) for backward compatibility with existing JSONB data.

​
relationship
enum<string>
default:external

Relationship between the current user and the contact.

Available options:
self,
external

Response

Successful Response