Clients - ON RAMP by Mesadepagos

El modulo Clients permite registrar personas o empresas vinculadas al business autenticado, iniciar su onboarding en Persona y consultar su estado.

Endpoints

Nombre	Metodo	Ruta
Crear cliente	`POST`	`/v2/business-clients`
Listar clientes	`GET`	`/v2/business-clients`

Ambos endpoints requieren un token JWT enviado como Bearer token.

Crear cliente

POST /v2/business-clients

Request

Campo	Tipo	Requerido	Descripcion
`name`	`string`	Si	Nombre de la persona o empresa.
`email`	`string`	Si	Correo electronico valido del cliente.
`type`	`string`	Si	`individual` o `company`.
`country`	`string`	Si	Codigo de pais de entre 2 y 4 caracteres.

{
  "name": "Acme Bolivia",
  "email": "cliente@example.com",
  "type": "company",
  "country": "BO"
}

Response

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

clientLink es el enlace de un solo uso que el cliente debe abrir para completar su onboarding en Persona.

Listar clientes

GET /v2/business-clients

Response

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

Los estados que actualmente devuelve la API son Pending, Onboarding, Active, Rejected y Suspended. externalClientId es null mientras el cliente todavia no tenga una relacion con el proveedor externo.