> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rebelfi.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# KYB Verification

> Start and manage Know Your Business verification for your organization

## 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.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://api.rebelfi.io/v1/ramp/org/kyb/start" \
    -H "x-api-key: your_api_key"
  ```

  ```typescript SDK theme={null}
  const result = await client.ramp.startKyb();
  ```
</CodeGroup>

### Response

```json theme={null}
{
  "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
```

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://api.rebelfi.io/v1/ramp/org/kyb/status" \
    -H "x-api-key: your_api_key"
  ```

  ```typescript SDK theme={null}
  const status = await client.ramp.getKybStatus();
  ```
</CodeGroup>

### Response

```json theme={null}
{
  "kybStatus": "approved",
  "applicationUrl": "https://kyb.provider.com/verify/abc123",
  "onrampAccount": {
    "id": 1,
    "accountNumber": "12345678",
    "routingNumber": "987654321",
    "bankName": "Lead Bank",
    "status": "active"
  },
  "onrampAccounts": []
}
```

<ResponseField name="kybStatus" type="string | null">
  Current KYB status: `pending`, `submitted`, `approved`, or `declined`
</ResponseField>

<ResponseField name="applicationUrl" type="string | null">
  URL to the hosted KYB verification form
</ResponseField>

<ResponseField name="onrampAccount" type="object | null">
  Primary on-ramp account, if one exists
</ResponseField>

<ResponseField name="onrampAccounts" type="array">
  All on-ramp accounts for the organization
</ResponseField>

***

## 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
```

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://api.rebelfi.io/v1/ramp/org/kyb/check-status" \
    -H "x-api-key: your_api_key"
  ```

  ```typescript SDK theme={null}
  const status = await client.ramp.checkKybStatus();
  ```
</CodeGroup>

### Response

Same shape as [Get KYB Status](#get-kyb-status).

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

***

## Simulate KYB Approval (Sandbox)

<Warning>
  This endpoint is only available in the **sandbox environment**. It will return an error in production.
</Warning>

Instantly approves KYB without actual verification. Useful for testing your integration end-to-end.

```
POST /v1/ramp/org/kyb/simulate-approve
```

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://api.rebelfi.io/v1/ramp/org/kyb/simulate-approve" \
    -H "x-api-key: your_api_key"
  ```

  ```typescript SDK theme={null}
  const status = await client.ramp.simulateKybApproval();
  ```
</CodeGroup>

### Response

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

***

## Simulate KYB Rejection (Sandbox)

<Warning>
  This endpoint is only available in the **sandbox environment**. It will return an error in production.
</Warning>

Instantly rejects KYB. Useful for testing declined flows.

```
POST /v1/ramp/org/kyb/simulate-reject
```

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://api.rebelfi.io/v1/ramp/org/kyb/simulate-reject" \
    -H "x-api-key: your_api_key"
  ```

  ```typescript SDK theme={null}
  const status = await client.ramp.simulateKybRejection();
  ```
</CodeGroup>

### Response

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