Get current user

Get the profile of the currently authenticated user.

GET /api/v1/user

Get current user

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/user \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "phone": "<string>",
  "avatarUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "contactInfo": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "entityName": "<string>",
  "birthDate": "2023-12-25",
  "country": "<string>",
  "jurisdiction": "<string>",
  "address": {
    "streetAddress": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "fiatRails": [],
  "isBusiness": true,
  "plan": "free",
  "referrer": {
    "name": "<string>",
    "email": "<string>",
    "avatarUrl": "<string>"
  },
  "pushNotificationAllowed": true,
  "myIp": "<string>",
  "bankRequested": {
    "rails": {
      "us": {
        "pooled": false,
        "named": false
      },
      "swift": {
        "pooled": false,
        "named": false
      },
      "eu": {
        "pooled": false,
        "named": false
      },
      "uae": {
        "pooled": false,
        "named": false
      }
    }
  }
}

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

device-id · string | null

device-type · string · default: ios

device-name · string · default: ios

x-api-key · string | null

Response

200

application/json

Successful Response

Schema for user response.

id · string<uuid> · required

email · string · required

phone · string | null · required

avatarUrl · string | null · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

contactInfo · string | null

firstName · string | null

middleName · string | null

lastName · string | null

entityName · string | null

birthDate · string<date> | null

country · string | null

jurisdiction · string | null

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

fiatRails · FiatRailResponse · object[]

Show child attributes

isBusiness · boolean | null

plan · string · default: free

referrer · ReferrerInfo · object | null

Lightweight info about the user who referred this user.

Show child attributes

pushNotificationAllowed · boolean | null

myIp · string | null

bankRequested · BankRequestedSettings · object

User bank-rail interest settings.

Show child attributes