Submit KYC data

Get Swipelux KYC verification link.

POST /api/v1/user/kyc_link

Submit KYC data

cURL

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

import requests

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

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

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

print(response.text)

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

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

200

{
  "email": "<string>",
  "externalUserId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "entityName": "<string>",
  "kycLink": "<string>",
  "kycUrl": "<string>",
  "contactSupportLink": "https://app.gethevn.com/chat"
}

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

Response

200

application/json

Successful Response

Response schema for KYC status check.

provider · enum<string> · required

Supported fiat payment providers.

Available options: swipelux, align, mcp, wirex

email · string · required

kycStatus · enum<string> · required

KYC verification status.

Available options: not_started, requested, incorporating, pending, under_review, in_review, approved, rejected

externalUserId · string | null

status · enum<string> | null

KYC verification status.

Available options: not_started, requested, incorporating, pending, under_review, in_review, approved, rejected

firstName · string | null

lastName · string | null

entityName · string | null

kycLink · string | null

kycUrl · string | null

contactSupportLink · string · default: https://app.gethevn.com/chat