Skip to main content
O SpherePay habilita um conjunto de perfis de verificação para a sua aplicação. enabledVerificationProfiles permite escolher, por cliente, contra quais desses perfis ele é avaliado. Um cliente só é verificado para os perfis que você seleciona, e só arca com o custo de verificação desses.

O campo

enabledVerificationProfiles é um array de letras de perfil em POST /v2/customer e PATCH /v2/customer/{id}. Ele se aplica aos clientes cadastrados pela API; clientes cadastrados por links KYC hospedados são inscritos nos perfis padrão da sua aplicação.
O SpherePay recomenda sempre enviar um array explícito. Isso torna a inscrição do cliente visível nos seus próprios registros e independente de mudanças posteriores na configuração da sua aplicação.
O conjunto de perfis que a sua aplicação pode usar é configurado pelo SpherePay. Para solicitar um perfil adicional para a sua aplicação, entre em contato com support@spherepay.co.

O que a API retorna

GET /v2/customer/{id} retorna dois campos relacionados:
  • enabledVerificationProfiles — os perfis em que o cliente está inscrito, sempre como um array explícito. Se você omitiu o campo na criação, é o conjunto para o qual a sua aplicação estava habilitada naquele momento.
  • verificationProfiles — os perfis que estão de fato sendo avaliados, cada um com seu status e criteria. Selecionar um perfil não garante que ele apareça aqui: um perfil para o qual o cliente não é elegível é omitido (veja abaixo).

Elegibilidade por país

A elegibilidade segue o país de residência do cliente (address.country). Residentes nos EUA podem usar apenas o perfil A. Residentes fora dos EUA podem usar os perfis A, C e D. Um perfil selecionado para o qual o cliente não é elegível é omitido de verificationProfiles; se nenhum dos perfis selecionados se aplicar, a solicitação é rejeitada.
  • Um residente nos EUA criado com ["a", "c"] é aceito, mas apenas kyc_profile_a aparece em verificationProfiles.
  • Um residente nos EUA criado com ["c"] ou ["d"] é rejeitado com 422 customer/verification-profile-not-enabled, porque nenhum perfil selecionado se aplica.

Alterar a seleção depois

Envie o novo array completo em PATCH /v2/customer/{id}. Omitir o campo mantém a seleção inalterada.
  • Adicionar um perfil expõe seus requisitos pendentes em criteria.required do novo perfil. Requisitos já atendidos para outro perfil são transferidos como complete. Veja Adicionar um perfil depois.
  • Remover um perfil só é permitido enquanto aquele perfil está em incomplete. Veja Remover um perfil.
Adicionar um perfil nunca reavalia os perfis existentes do cliente. Os campos que esses perfis já avaliaram permanecem bloqueados enquanto estiverem em pending ou approved — veja Quando os dados do cliente podem ser atualizados.

Clientes pessoa jurídica

Defina enabledVerificationProfiles na empresa ao criá-la. Cada representante da empresa que você adicionar é avaliado contra os mesmos perfis, como ubo_kyc_profile_*; os representantes não carregam a própria seleção. Alterar a seleção de uma empresa após a criação ainda não é suportado via PATCH. Entre em contato com seu representante do SpherePay se uma empresa existente precisar de um novo perfil.

Referência de erros


Guias relacionados

Visão geral dos perfis de verificação

Quais perfis existem, o que cada um exige e desbloqueia.

Cadastrar um cliente com perfis

Escolha perfis na criação e adicione um depois.
Última modificação em 22 de setembro de 2026