Create contact

Create a new contact for the current user.

POST /api/v1/user/contact

Create contact

cURL

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>"
  }
}
'

import requests

url = "https://api.hevn.finance/api/v1/user/contact"

payload = {
    "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>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
    }
  })
};

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

422

{
  "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 | null

Crypto contact input.

Show child attributes

account · OnchainAccountInput · object

Onchain wallet contact input.

OnchainAccountInput

EmailAccountInput

SepaAccountInput

SwiftAccountInput

AchAccountInput

UaeAccountInput

Show child attributes

iban · IBANAccountDetails · object

IBAN (SEPA) external account.

IBANAccountDetails

USExternalAccountDetails

SwiftAccountDetails

Show child attributes

address · UserAddress · object | null

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.

Show child attributes

relationship · enum<string> · default: external

Relationship between the current user and the contact.

Available options: self, external

Response

201

application/json

Successful Response