Webhooks de Credenciamento

Essa página é dedicada apenas aos Webhook do fluxo de Credenciamento. Para mais informações sobre Webhooks, acesse o Catálogo de Webhooks.

Tipo	Descrição
`onboarding.waiting_required_documents`	Onboarding aguardando documentos obrigatórios
`onboarding.approved`	Onboarding aprovado
`onboarding.rejected`	Onboarding negado

`onboarding.waiting_required_documents`

Descrição: Esse webhook é enviado após o credenciamento ser iniciado com o envio dos dados cadastrais na Etapa 1. O webhook indica que o Marketplace deve realizar o Etapa 02 - Envio de Documentos.

{
  "body": {
    "type": "onboarding.waiting_required_documents",
    "resource": "onboarding",
    "description": "An onboarding is awaiting documents",
    "object": {
      "onboarding_id": "onboarding-1",
      "external_reference_id": null,
      "status": "WAITING_DOCUMENTS"
    }
  }
}

`onboarding.approved`

Descrição: Após solicitar análise (etapa 03), o nosso motor de KYC vai realizar todas avaliações necessárias e retornará através deste webhook caso o cliente seja aprovado nas análises.

{
  "type": "onboarding.completed",
  "resource": "onboarding",
  "description": "An onboarding was completed",
  "object": {
    "onboarding_id": "onboarding-1",
    "external_reference_id": null,
    "profile_id": "11111111-1111-4111-8111-111111111111",
    "status": "APPROVED"
  }
}

`onboarding.rejected`

Descrição: Após solicitar análise (etapa 03), o nosso motor de KYC vai realizar todas avaliações necessárias e retornará através deste webhook caso o cliente seja reprovado nas análises.

{
  "body": {
    "type": "onboarding.rejected",
    "resource": "onboarding",
    "description": "An onboarding was rejected",
    "object": {
      "onboarding_id": "onboarding-1",
      "external_reference_id": null,
      "profile_id": "11111111-1111-4111-8111-111111111111",
      "status": "REJECTED",
      "retry": true,
      "decision_reasons": [
        {
          "reason": "INTERNAL_KYC_POLICY",
          "detail": "DOCUMENT_NOT_MATCH"
        }
      ]
    }
  }
}

📋 Campos de cada item em `decision_reasons` e `retry`

Campo	Tipo	Descrição
reason	string	Categoria do motivo de negação (ex: DOCUMENT_VALIDATION, REGISTRATION_INCONSISTENCY)
detail	string	Detalhe específico associado ao motivo (ex: DOCUMENT_NOT_MATCH, NAME_INVALID)
retry	boolean	Indica se o marketplace pode realizar uma nova tentativa de credenciamento ou as negativas não apontam possibilidade de serem aprovadas mesmo em um novo processo

📊 Tabela de reason e detail

reason (categoria)	detail (detalhe)	Descrição
DOCUMENT_VALIDATION	DOCUMENT_NOT_MATCH	Documento ilegível ou não corresponde à pessoa da selfie enviada
DOCUMENT_VALIDATION	DOCUMENT_QUALITY	Foto do documento e/ou da Selfie com baixa qualidade, impossibilitando análise
INTERNAL_KYC_POLICY	—	Credenciamento negado por política interna Zoop
FRAUD_PREVENTION	—	Credenciamento negado por política interna de prevenção à fraude Zoop
REGISTRATION_INCONSISTENCY	NAME_INVALID	Nome diverge do cadastro oficial da Receita Federal
REGISTRATION_INCONSISTENCY	BIRTH_DATE_INVALID	Data de nascimento diverge do cadastro oficial da Receita Federal
REGISTRATION_INCONSISTENCY	REGISTRATION_STATUS_INVALID	CPF/CNPJ com situação irregular na Receita Federal

Importante | Significado dos Campos
O campo decision_reasons é um array de objetos — um mesmo credenciamento pode acumular múltiplos motivos de negativa, cada um com seu próprio detail.
O campo retry indica se o marketplace pode realizar uma nova tentativa de credenciamento desse cliente, ou seja, se o(s) motivo(s) de negativa forem passíveis de correção, será indicada a possibilidade de nova tentativa de cadastro.

Updated about 7 hours ago

Did this page help you?