Upload KYC docs

curl --request POST \
  --url https://api.etherfuse.com/ramp/customer/{customer_id}/kyc/documents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentType": "document",
  "images": [
    {
      "image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...",
      "label": "front"
    },
    {
      "image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...",
      "label": "back"
    }
  ],
  "pubkey": "GDUKMGUGD3V6VXTU2RLAUM7A2FABLMHCPWTMDHKP7HHJ6FCZKEY4PVWL"
}
'

{
  "message": "Documents uploaded for review",
  "status": "proposed"
}

KYC

Upload KYC docs

Upload identity documents (government ID, selfie) for a customer.

Document requirements:

Formats: JPEG, PNG
Max size: 10 MB per image
Required documents: id_front, id_back (if applicable), selfie
Encoding: Base64

Use the documentType field: document for government ID images (front and back), selfie for the selfie verification photo.

Submitted documents are reviewed by Etherfuse admins before approval; you’ll receive a kyc_updated webhook when the status changes.

Sandbox auto-approval: in sandbox, uploading documents for a personal customer org immediately approves the customer and fires a kyc_updated webhook (response status is "approved"). Sandbox-only — production still requires manual review.

POST

ramp

customer

{customer_id}

kyc

documents

Upload KYC docs

curl --request POST \
  --url https://api.etherfuse.com/ramp/customer/{customer_id}/kyc/documents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentType": "document",
  "images": [
    {
      "image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...",
      "label": "front"
    },
    {
      "image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...",
      "label": "back"
    }
  ],
  "pubkey": "GDUKMGUGD3V6VXTU2RLAUM7A2FABLMHCPWTMDHKP7HHJ6FCZKEY4PVWL"
}
'

{
  "message": "Documents uploaded for review",
  "status": "proposed"
}

Authorizations

Authorization

string

header

required

API key sent in the Authorization header.

Path Parameters

customer_id

string<uuid>

required

The customer (child org) ID. Must belong to the caller's organization or a direct child.

Body

application/json

Request body for uploading KYC documents

documentType

string

required

Document type: "document" (ID) or "selfie"

images

object[]

required

Array of images to upload

Show child attributes

identityUpdate

object

Optional identity data to associate with the document

Show child attributes

pubkey

string | null

The public key of the wallet to submit KYC for (optional — omit to attach to org only)

Response

KYC documents uploaded

Get org KYC status Get KYC status

⌘I