Clients - ON RAMP by Mesadepagos

The Clients module registers individuals or companies associated with the authenticated business, starts their Persona onboarding, and retrieves their status.

Endpoints

Name	Method	Path
Create client	`POST`	`/v2/business-clients`
List clients	`GET`	`/v2/business-clients`

Both endpoints require a JWT sent as a Bearer token.

Create a Client

POST /v2/business-clients

Request

Field	Type	Required	Description
`name`	`string`	Yes	Name of the individual or company.
`email`	`string`	Yes	Valid client email address.
`type`	`string`	Yes	`individual` or `company`.
`country`	`string`	Yes	Country code with 2 to 4 characters.
`settlementNetwork`	`string`	No	`Ethereum` or `Polygon`; defaults to `Polygon`.
`settlementAsset`	`string`	No	`USDC` or `USDT`; defaults to `USDC`.

{
  "name": "Acme Bolivia",
  "email": "client@example.com",
  "type": "company",
  "country": "BO",
  "settlementNetwork": "Polygon",
  "settlementAsset": "USDC"
}

Response

{
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "clientLink": "https://withpersona.com/verify/example"
}

clientLink is the one-time link the client opens to complete Persona onboarding. The selected network and asset are used to settle virtual account collections. The API validates that the combination is available when creating the client and returns 400 if it is not. These fields are not included in the creation response. See the virtual accounts flow to request currency endorsements and register a withdrawal address.

List Clients

GET /v2/business-clients

Response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Bolivia",
    "type": "company",
    "status": "Active",
    "country": "BO",
    "email": "client@example.com",
    "externalClientId": null
  }
]

The API currently returns Pending, Onboarding, Active, Rejected, and Suspended statuses. externalClientId is null while the client does not yet have a relationship with the external provider.

​Endpoints

​Create a Client

​Request

​Response

​List Clients

​Response

Endpoints

Create a Client

Request

Response

List Clients

Response