Get KYB status - Etherfuse API

Get KYB status

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

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

fetch('https://api.sand.etherfuse.com/ramp/organization/{id}/kyb/status', 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/status"

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

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

print(response.text)

{
  "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "submitted",
  "approvedAt": null
}

GET

/

ramp

/

organization

/

{id}

/

kyb

/

status

Get KYB status

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

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

fetch('https://api.sand.etherfuse.com/ramp/organization/{id}/kyb/status', 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/status"

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

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

print(response.text)

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

An organization's KYB verification state: the same shape the kyb_updated webhook delivers, so you can poll or subscribe without learning two payloads.

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

approvedAt

string<date-time> | null

required

When the organization was approved, or null if it is not approved yet.

⌘I