Skip to main content
GET
/
ramp
/
organization
/
{id}
/
kyb
/
progress
Get KYB progress
curl --request GET \
  --url https://api.sand.etherfuse.com/ramp/organization/{id}/kyb/progress \
  --header 'Authorization: <api-key>'
{
  "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "awaiting_review",
  "approved": 3,
  "submitted": 6,
  "notStarted": 0,
  "total": 9,
  "approvedAt": null
}

Authorizations

​
Authorization
string
header
required

API key sent in the Authorization header.

Path Parameters

​
id
string<uuid>
required

The business organization.

Response

KYB progress for the organization

KYB progress for a business organization. Counts cover the customer-facing requirements only; admin-only requirements are excluded and never affect the status.

​
organizationId
string<uuid>
required

ID of the business organization this KYB belongs to.

​
status
enum<string>
required

not_started: no requirements answered yet. awaiting_documents: the customer has requirements left to fill or upload and nothing is blocking them (the ball is in their court). awaiting_review: the ball is in Etherfuse's court (open clarification notes for Etherfuse to answer, or every requirement submitted and awaiting review). approved: KYB approved. denied: KYB denied.

Available options:
not_started,
awaiting_documents,
awaiting_review,
approved,
denied
​
approved
integer<int64>
required

Requirements with an approved answer.

​
submitted
integer<int64>
required

Requirements answered but not yet approved.

​
notStarted
integer<int64>
required

Requirements with no answer yet.

​
total
integer<int64>
required

Total applicable requirements (approved + submitted + notStarted).

​
approvedAt
string<date-time> | null

When the org's KYB was approved, or null if not yet approved.