Skip to main content

​
Start KYB

Initiates KYB verification and returns a hosted form URL. Send this URL to the recipient to complete verification. 
POST /v1/ramp/org/kyb/start

​
Request

No request body required. Authenticate with your API key. 
curl -X POST "https://api.rebelfi.io/v1/ramp/org/kyb/start" \
  -H "x-api-key: your_api_key"

​
Response

{
  "kyb_status": "pending",
  "kyb_url": "https://kyb.provider.com/verify/abc123"
}

​
Get KYB Status

Returns the current KYB status for your organization. 
GET /v1/ramp/org/kyb/status

curl "https://api.rebelfi.io/v1/ramp/org/kyb/status" \
  -H "x-api-key: your_api_key"

​
Response

{
  "kybStatus": "approved",
  "applicationUrl": "https://kyb.provider.com/verify/abc123",
  "onrampAccount": {
    "id": 1,
    "accountNumber": "12345678",
    "routingNumber": "987654321",
    "bankName": "Lead Bank",
    "status": "active"
  },
  "onrampAccounts": []
}
​
kybStatus
string | null
Current KYB status: pending, submitted, approved, or declined
​
applicationUrl
string | null
URL to the hosted KYB verification form
​
onrampAccount
object | null
Primary on-ramp account, if one exists
​
onrampAccounts
array
All on-ramp accounts for the organization

​
Check KYB Status

Forces a re-check of KYB status with the payment provider. Use this if you suspect the status may have changed since the last fetch. 
POST /v1/ramp/org/kyb/check-status

curl -X POST "https://api.rebelfi.io/v1/ramp/org/kyb/check-status" \
  -H "x-api-key: your_api_key"

​
Response

Same shape as Get KYB Status. 
{
  "kybStatus": "approved",
  "applicationUrl": "https://kyb.provider.com/verify/abc123",
  "onrampAccount": null,
  "onrampAccounts": []
}

​
Simulate KYB Approval (Sandbox)

This endpoint is only available in the sandbox environment. It will return an error in production.
Instantly approves KYB without actual verification. Useful for testing your integration end-to-end. 
POST /v1/ramp/org/kyb/simulate-approve

curl -X POST "https://api.rebelfi.io/v1/ramp/org/kyb/simulate-approve" \
  -H "x-api-key: your_api_key"

​
Response

{
  "kybStatus": "approved",
  "applicationUrl": "https://kyb.provider.com/verify/abc123",
  "onrampAccount": null,
  "onrampAccounts": []
}

​
Simulate KYB Rejection (Sandbox)

This endpoint is only available in the sandbox environment. It will return an error in production.
Instantly rejects KYB. Useful for testing declined flows. 
POST /v1/ramp/org/kyb/simulate-reject

curl -X POST "https://api.rebelfi.io/v1/ramp/org/kyb/simulate-reject" \
  -H "x-api-key: your_api_key"

​
Response

{
  "kybStatus": "declined",
  "applicationUrl": "https://kyb.provider.com/verify/abc123",
  "onrampAccount": null,
  "onrampAccounts": []
}