Get KYB progress

curl --request GET \
  --url https://api.sand.etherfuse.com/ramp/organization/{id}/kyb/progress \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sand.etherfuse.com/ramp/organization/{id}/kyb/progress', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sand.etherfuse.com/ramp/organization/{id}/kyb/progress"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "submitted",
  "approved": 3,
  "submitted": 6,
  "notStarted": 0,
  "total": 9,
  "approvedAt": null
}

Deprecated

Get KYB progress

deprecated

Deprecated: use Get KYB status. The per-requirement counts here describe Etherfuse’s in-house onboarding model, which is being retired. status is the one field that carries over, and its values were renamed in this same change: awaiting_documents is now in_progress and awaiting_review is now submitted. Both endpoints serve the new names.

Returns KYB progress for a business organization so you can track your customer’s verification without portal access: requirement completion counts, the overall status, and the approval timestamp.

The target org must be a business org you own (your own org or a direct child).

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>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sand.etherfuse.com/ramp/organization/{id}/kyb/progress', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sand.etherfuse.com/ramp/organization/{id}/kyb/progress"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "submitted",
  "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

The KYB status. not_started: verification hasn't begun. in_progress: the customer has something left to submit. submitted: everything the customer can do is done and it's Etherfuse's turn, including an open note the customer is waiting on an answer to. A note Etherfuse has asked the customer to answer reads in_progress. approved: KYB approved, the business can transact. denied: KYB denied.

Available options:

not_started,

in_progress,

submitted,

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

required

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

⌘I