Pular para o conteúdo principal
Create Customer via Link
curl --request POST \
  --url https://api.spherepay.co/v2/customer/kyc-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "individual",
  "email": "jane.smith@example.com",
  "phone": "+14155550123",
  "address": {
    "line1": "233 South Wacker Drive",
    "city": "Chicago",
    "country": "USA",
    "line2": "Suite 4700",
    "state": "IL",
    "postalCode": "60606"
  }
}
'
{
  "customerId": "customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7",
  "url": "https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx",
  "expiresAt": "2026-03-09T20:46:31.305Z"
}
Use este endpoint para criar um cliente e gerar um link KYC hospedado em uma única solicitação. Em vez de criar o cliente primeiro e depois solicitar um link separadamente, você fornece aqui o tipo, email, telefone e endereço do cliente, e a resposta retorna o ID do novo cliente junto com uma URL de verificação hospedada com tempo limitado. Redirecione o cliente para esta URL para concluir as verificações de identidade com o provedor de verificação.
Clientes criados através deste fluxo de link de onboarding só podem ser gerenciados com os endpoints de links de onboarding — eles não são compatíveis com os fluxos diretos de onboarding da API. Da mesma forma, clientes integrados através dos outros fluxos da API não podem ser usados com os endpoints de links de onboarding.
A URL retornada expira no momento indicado por expiresAt — por padrão, 4 semanas (28 dias) após a criação. Este padrão pode mudar sem aviso prévio, então confie sempre em expiresAt em vez de assumir uma duração fixa. Se o link expirar antes de o cliente concluir a verificação, gere um novo com Regenerar Link KYC usando o customerId desta resposta.

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
​
type
enum<string>
obrigatório

The type of customer to onboard.

Opções disponíveis:
individual,
business
Exemplo:

"individual"

​
email
string<email>
obrigatório

The customer email address.

Maximum string length: 254
Exemplo:

"jane.smith@example.com"

​
phone
string
obrigatório

The customer phone number in E.164 format.

Pattern: ^\+(?:[0-9]){6,14}[0-9]$
Exemplo:

"+14155550123"

​
address
object
obrigatório

The customer's address. For individual customers this is the residential address; for business customers this is the registered business address.

Resposta

​
customerId
string
obrigatório

The ID of the customer the KYC link belongs to

Exemplo:

"customer_b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7"

​
url
string
obrigatório

Hosted KYC URL

Exemplo:

"https://in.sumsub.com/websdk/p/sbx_uq30ag1ov7oHZhmx"

​
expiresAt
string
obrigatório

ISO 8601 formatted date and time of the KYC URL expiration. By default, links expire 4 weeks (28 days) after creation, but this default may change without notice — always rely on this field rather than assuming a fixed duration.

Exemplo:

"2026-03-09T20:46:31.305Z"

Última modificação em 2 de julho de 2026