Create Recipient

curl --request POST \
  --url https://api.example.com/v1/ramp/recipients

import requests

url = "https://api.example.com/v1/ramp/recipients"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.example.com/v1/ramp/recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/ramp/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/ramp/recipients"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/ramp/recipients")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/ramp/recipients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

POST

ramp

recipients

Create Recipient

curl --request POST \
  --url https://api.example.com/v1/ramp/recipients

import requests

url = "https://api.example.com/v1/ramp/recipients"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.example.com/v1/ramp/recipients', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/ramp/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/ramp/recipients"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/ramp/recipients")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/ramp/recipients")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

Endpoint: POST https://api.rebelfi.io/v1/ramp/recipients

Create a new recipient for ramping operations. This initiates KYB (Know Your Business) verification and returns a URL for the recipient to complete the process.

Request Body

Field	Type	Required	Description
`name`	`string`	Yes	Recipient name
`type`	`string`	No	Recipient type (default: `"business"`)
`external_id`	`string`	No	Your external reference ID
`address`	`object`	No	Recipient address (required before creating off-ramp accounts)
`address.street1`	`string`	Yes*	Street address line 1 (*required if `address` is provided)
`address.street2`	`string`	No	Street address line 2
`address.city`	`string`	Yes*	City (*required if `address` is provided)
`address.region`	`string`	No	State or region
`address.postal_code`	`string`	No	Postal code
`address.country`	`string`	No	Country code (default: `"US"`)

Example Request

curl -X POST "https://api.rebelfi.io/v1/ramp/recipients" \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "OnEdge",
    "type": "business",
    "external_id": "ref-123"
  }'

const recipient = await client.ramp.createRecipient({
  name: 'OnEdge',
  type: 'business',
  externalId: 'ref-123'
});

Example Response

{
  "id": 1,
  "name": "OnEdge",
  "type": "business",
  "external_id": "ref-123",
  "kyb_status": "pending",
  "kyb_url": "https://kyb.provider.com/verify/abc123",
  "created_at": "2025-06-01T12:00:00.000Z"
}

Response Fields

Field	Type	Description
`id`	`number`	Recipient identifier
`name`	`string`	Recipient name
`type`	`string`	Recipient type
`external_id`	`string?`	Your external reference ID
`kyb_status`	`string`	KYB verification status (`pending`)
`kyb_url`	`string`	URL for the recipient to complete KYB verification
`created_at`	`string`	Creation timestamp (ISO 8601)

The kyb_url is the link you send to the recipient for KYB verification. The recipient must complete verification before they can be used for off-ramp operations.

KYB Status List Recipients

​Request Body

​Example Request

​Example Response

​Response Fields

Request Body

Example Request

Example Response

Response Fields