Create contact

Create a new contact for the current user.

POST /api/v1/user/contact

Create contact

cURL

curl --request POST \
  --url https://api.example.com/api/v1/user/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "<string>",
  "email": "<string>",
  "iban": {
    "bankName": "<string>",
    "bankAddress": {
      "addressLine1": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    },
    "currency": "<string>",
    "accountHolderFirstName": "<string>",
    "accountHolderLastName": "<string>",
    "accountHolderBusinessName": "<string>",
    "accountHolderAddress": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "businessIndustry": "<string>",
    "paymentReference": "<string>",
    "accountType": "sepa",
    "ibanNumber": "<string>",
    "bic": "<string>"
  },
  "address": {
    "streetAddress": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  }
}
'

422

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

Authorizations

Authorization · string · header · 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

UkFpsAccountInput

PixAccountInput

Show child attributes

iban · IBANAccountDetails · object

IBAN (SEPA) external account.

IBANAccountDetails

USExternalAccountDetails

SwiftAccountDetails

PixAccountDetails

LocalRailAccountDetails

ProviderUsdAccountDetails

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

How a payout contact relates to the user.

The vocabulary mirrors Swipelux's recipient relationships so the common values project onto their API unchanged, but this is our own domain type: SELF marks a first-party payout to the user's own account at another bank and has no Swipelux counterpart. Providers own that projection — see SwipeluxRecipients._recipient_relationship — so nothing here depends on a provider, and no provider enum has to carry a value it cannot accept.

Available options: employee, contractor, vendor, subsidiary, merchant, customer, landlord, family, other, self

Response

201

application/json

Successful Response