Skip to main content
POST
/
api
/
v1
/
opt-in
Yield Opt In
curl --request POST \
  --url https://sandbox-b2b.ripio.com/api/v1/opt-in/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048"
}
'
[
  {
    "id": "c468be09-3a1f-41aa-ad08-c7d715957105",
    "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb0e",
    "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf051",
    "asset": "BTC",
    "created_at": "2025-04-10T15:53:11.847992Z",
    "opt_out_at": null,
    "is_active": true
  },
  {
    "id": "c468be09-3a1f-41aa-ad08-c7d715957106",
    "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb01",
    "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf052",
    "asset": "ETH",
    "created_at": "2025-04-10T15:53:11.847993Z",
    "opt_out_at": null,
    "is_active": true
  }
]

Authorizations

​
Authorization
string
header
required

B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow:

  • clientCredentials allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication.

Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (client id and client secret) that will be needed to generate a credential in order to negotiate an ephemeral access token.

Every request must be accompianed by an Authorization header with a value that follows the following schema: Bearer ACCESS_TOKEN

Body

application/json
​
end_user_id
string

End user's external ref.

Response

Successful Creation

​
id
string<uuid>

UUID used as opt in identifier.

​
transaction_id
string<uuid>

UUID used as opt in's transaction identifier.

​
end_user_id
string<uuid>

Unique identifier used as end user's external ref.

​
asset
string

Asset symbol.

​
created_at
string<date-time>

ISO format creation datetime

​
opt_out_at
string<date-time> | null

ISO format opt out datetime

​
is_active
boolean

Indicates if the opt in is active.