Kyc

KYC Status

get

Retrieve the current status of a KYC verification

Authorizations

Authorization

Path parameters

kyc_idstringRequired

The unique identifier of the KYC link

Header parameters

Authorization-SignaturestringRequired

Authorization header format: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'

Responses

200

KYC link details

application/json

idstringRequired

typestringRequired

customer_idstring · nullableOptional

full_namestring · nullableOptional

emailstringRequired

kyc_linkstringRequired

kyc_statusstringRequired

tos_linkstringRequired

tos_statusstringRequired

created_atstring · nullableOptional

400

Bad Request - Missing kyc_id

application/json

401

Unauthorized - Authentication required

application/json

500

Internal Server Error

application/json

get

/kyc

HTTPcURLJavaScriptPython

GET /v2/kyc HTTP/1.1
Authorization-Signature: text
Accept: */*

{
  "id": "text",
  "type": "text",
  "customer_id": null,
  "full_name": null,
  "email": "text",
  "kyc_link": "text",
  "kyc_status": "text",
  "rejection_reasons": [
    {
      "developer_reason": "text",
      "reason": "text",
      "created_at": "text"
    }
  ],
  "tos_link": "text",
  "tos_status": "text",
  "created_at": null
}

Create KYC Link

post

Generate a KYC/TOS verification link via Bridge.xyz for a customer to complete identity verification

Authorizations

Authorization

Header parameters

Authorization-SignaturestringRequired

Authorization header format: 'APIKey=<api_key>,signature=,timestamp=<unix_timestamp>'

Body

application/json

emailstringRequired

typestringRequired

full_namestringOptional

endorsementsstring[]Optional

redirect_uristringOptional

Responses

201

KYC link created successfully

application/json

400

Bad Request - Missing required fields

application/json

401

Unauthorized - Authentication required

application/json

422

Unprocessable Entity - Invalid request body format

application/json

500

Internal Server Error

application/json

post

/kyc

HTTPcURLJavaScriptPython

POST /v2/kyc HTTP/1.1
Authorization-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "email": "text",
  "type": "text",
  "full_name": "text",
  "endorsements": [
    "text"
  ],
  "redirect_uri": "text"
}

{
  "id": "text",
  "type": "text",
  "customer_id": null,
  "full_name": null,
  "email": "text",
  "kyc_link": "text",
  "kyc_status": "text",
  "rejection_reasons": [
    {
      "developer_reason": "text",
      "reason": "text",
      "created_at": "text"
    }
  ],
  "tos_link": "text",
  "tos_status": "text",
  "created_at": null
}