Catálogo de enums dinâmicos da Autra

Retorna o catálogo de IDs numéricos que o backend Autra exige nos payloads
de cadastro PF/PJ. A Autra não aceita strings ("MALE", "MARRIED",
"RESIDENTIAL"); espera IDs (gender_id: 3, marital_status_id: 1,
address.type_id: 12). Os IDs mudam por ambiente (sandbox ≠ produção)
e podem ser atualizados pela Autra — por isso é catálogo dinâmico, não enum
hardcoded no frontend.

Quando usar

Sempre que renderizar formulário de:

  • Cadastro PFgender_id, marital_status_id, telefone, email, endereço, documento
  • Cadastro de sócio (PJ) — todos os campos acima por sócio
  • Cadastro da empresa (PJ) — endereço, telefone, email da empresa

Fluxo típico no frontend:

  1. Ao abrir tela de cadastro → GET /v1/banking/onboarding/setup-types
  2. Backend devolve as 6 categorias (cacheadas — <50ms)
  3. Renderiza dropdowns: <option value={id}>{description}</option>
  4. Ao submeter, manda os id selecionados nos campos do payload

Categorias disponíveis

categoryOnde aparece no payloadExemplos de description
GENDERpersonal_data.gender_id, partners[].gender_idMALE, FEMALE, OTHER
MARITAL_STATUSpersonal_data.marital_status_id, partners[].marital_status_idSINGLE, MARRIED, DIVORCED, WIDOWED, STABLE_UNION
ADDRESSaddress.type_id (PF e PJ)RESIDENTIAL, COMMERCIAL, BILLING
PHONEphone.type_id (PF, sócios, empresa)MOBILE, LANDLINE, BUSINESS
EMAILemail.type_id (PF, sócios, empresa)PERSONAL, BUSINESS
DOCUMENTdocument.type_id no upload de arquivosRG, CNH, PASSPORT, CCMEI, CSC, SELFIE, … (até 17 tipos)

Filtro opcional

  • Sem filtro (GET /setup-types) → retorna todas as 6 categorias de uma vez (recomendado: 1 round-trip pra montar todo o form)
  • Com ?category=GENDER → retorna só essa categoria (útil pra hot-reload de um campo específico)

Cache

  • Cacheado em memória do Lambda após o primeiro LoadAll (cold start dispara em goroutine, ~200ms paralelo).
  • Subsequentes chamadas servem do cache (<50ms).
  • Cache invalida apenas em cold start (deploy ou ociosidade > 15min).
  • Para forçar refresh: re-deploy do banking lambda.

Auth

Cognito (master logado do tenant). Não é público.

Mapeamento com payloads PJ

Veja referências no schema:

  • OnbPersonalDataRequest.gender_idcategory=GENDER
  • OnbPersonalDataRequest.marital_status_idcategory=MARITAL_STATUS
  • OnbAddress.type_idcategory=ADDRESS
  • OnbPhone.type_idcategory=PHONE
  • OnbDocument.type_idcategory=DOCUMENT (no upload de arquivos)
  • email.type_id (não está em schema dedicado mas obrigatório no payload PJ) ← category=EMAIL
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json