Skip to main content
POST
/
api
/
v1
/
user
/
kyc_link
Submit KYC data
curl --request POST \
  --url https://api.hevn.finance/api/v1/user/kyc_link \
  --header 'Authorization: Bearer <token>'
{
  "email": "<string>",
  "externalUserId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "entityName": "<string>",
  "kycLink": "<string>",
  "kycUrl": "<string>",
  "contactSupportLink": "https://app.gethevn.com/chat"
}

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

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