Skip to main content
POST
/
api
/
companies
/
{company_id}
/
kyb
Submit company KYB
curl --request POST \
  --url https://api.sandbox.bitwage.com/api/companies/{company_id}/kyb \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoke": true
}'
{
  "company_id": "<string>",
  "kyb_status": "<string>",
  "requirements": {
    "missing_fields": [
      "<string>"
    ],
    "has_ubo_admin": true,
    "has_beneficial_owner": true,
    "has_ubo_kyc_initiated": true,
    "has_ubo_documents": true,
    "outstanding": [
      "<string>"
    ]
  },
  "rejection_reasons": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

API key authentication. Include your access token as: Authorization: Basic <ACCESS_TOKEN>

Headers

Idempotency-Key
string

Unique key for idempotent requests. Recommended for all write operations.

Path Parameters

company_id
string
required

Company ID.

Body

application/json
invoke
boolean
default:true

Whether to invoke the KYB check immediately.

Response

200 - application/json

KYB submitted.

company_id
string
kyb_status
string
requirements
object
rejection_reasons
string[]