Start KYC

Start KYC

curl --request POST \
  --url http://localhost:3000/api/integrations/breb/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userAddress": "0x2222222222222222222222222222222222222222",
  "fullName": "Ana Pérez",
  "email": "ana@example.com"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userAddress: '0x2222222222222222222222222222222222222222',
    fullName: 'Ana Pérez',
    email: 'ana@example.com'
  })
};

fetch('http://localhost:3000/api/integrations/breb/kyc', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:3000/api/integrations/breb/kyc"

payload = {
    "userAddress": "0x2222222222222222222222222222222222222222",
    "fullName": "Ana Pérez",
    "email": "ana@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "status": "needs_otp",
  "kycLink": "<string>",
  "tosLink": "<string>"
}

{
  "error": "<string>",
  "errorCode": "below_minimum"
}

{
  "error": "<string>"
}

POST

api

integrations

breb

kyc

Start KYC

curl --request POST \
  --url http://localhost:3000/api/integrations/breb/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userAddress": "0x2222222222222222222222222222222222222222",
  "fullName": "Ana Pérez",
  "email": "ana@example.com"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userAddress: '0x2222222222222222222222222222222222222222',
    fullName: 'Ana Pérez',
    email: 'ana@example.com'
  })
};

fetch('http://localhost:3000/api/integrations/breb/kyc', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "http://localhost:3000/api/integrations/breb/kyc"

payload = {
    "userAddress": "0x2222222222222222222222222222222222222222",
    "fullName": "Ana Pérez",
    "email": "ana@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "status": "needs_otp",
  "kycLink": "<string>",
  "tosLink": "<string>"
}

{
  "error": "<string>",
  "errorCode": "below_minimum"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Integration API key. Send as Bearer copby_live_pk_….

Body

application/json

userAddress

string

required

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0x2222222222222222222222222222222222222222"

fullName

string

required

string<email>

required

redirectUri

string<uri>

Response

Next KYC step

status

enum<string>

Available options:

needs_otp,

needs_kyc,

approved

kycLink

string

tosLink

string

BRE-B

Webhooks

Swaps

Authorizations

Body

Response