Catalisa.Building Blocks

API do People

15 endpoints em 1 recurso. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

16 endpoints

Geral

16
  • POST/peopleCria **ou reconhece** por documento; idempotente por externalRef. 201 na criação, 200 no reconhecimentoPEOPLE_WRITE
  • GET/peopleLista por **cursor** (?cursor=&limit=&externalRef=)PEOPLE_READ
  • GET/people/:idFicha, documento **mascarado**. ?reveal=true exige PEOPLE_READ_DOCUMENT e publica eventoPEOPLE_READ
  • PATCH/people/:idAtualiza nome, externalRef, atributos, contatos e endereços — sempre com procedênciaPEOPLE_WRITE
  • GET/people/:id/attributesAtributos com origem, confiança, validade e **divergência derivada**PEOPLE_READ
  • POST/people/resolveResolve **até 100** referências (id, externalRef ou documento) numa chamada; cada item volta { person, error? }PEOPLE_READ
  • POST/people/contacts/resolveO melhor contato de um tipo (PHONE ou EMAIL) de até 100 pessoas cuja **POSSE foi provada por fluxo interno** (código enviado a ele e confirmado — PeoplePersonService.confirmContactPossession; a rota POST /people/:id/contacts/possession só responde à identidade interna de servidor, para qualquer outro chamador é 404), com o valor ainda igual ao da prova (HMAC). verifiedAt/verificationId gravados por PATCH ou POST /verifications **não** contam. Principal primeiro; vencido não conta; sem posse provada, contact: null. reveal: true traz o valor em claro, exige PEOPLE_READ_DOCUMENT (só JWT) e publica people.contact.revealed (só id e tipo). É o telefone do código do revínculo do banking — fachada resolveContact. **Quem confirma posse hoje: a abertura de conta do banking** (o código foi ao telefone informado e conferido; evento people.contact.possession_confirmed, com quem provou e sem o valor). Fora dela, só contato marcado por migração/seed tem possePEOPLE_READ
  • GET/people/:id/assurance?required=&dimensions=&cache= — nível por dimensão, satisfied e o que faltaPEOPLE_READ
  • POST/assurance/batchAté 100 referências, resposta **207** item a itemPEOPLE_READ
  • POST/people/:id/documentsRegistra documento (tipo, emissor, validade, fileId)PEOPLE_WRITE
  • GET/people/:id/documentsLista documentos e situaçãoPEOPLE_READ
  • POST/people/:id/verificationsRegistra verificação — nossa (INTERNAL) ou trazida pelo cliente (EXTERNAL)PEOPLE_VERIFY
  • GET/people/:id/verificationsHistóricoPEOPLE_READ
  • POST/verifications/ingest**Lote** de evidência externa, com chave de idempotência por registro; 207PEOPLE_VERIFY
  • GET/config/policyO teto que evidência externa pode sustentar (externalMaxGrade) e se é o padrãoPEOPLE_READ
  • PUT/config/policyDefine o teto. Só a **organização**: subconta recebe 403 SUBACCOUNT_SCOPE_FORBIDDENPEOPLE_ADMIN