Consulta o andamento do cadastro de uma sub-conta (passos, documentos, última mudança de status)

GET/v1/marketplace/sub-accounts/{companyId}/onboarding

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros do caminho

companyIdstringobrigatório
Identificador público (bus_…)

Respostas

200Sucesso

idstringobrigatório
Identificador público (bus_…)
statusstringobrigatóriopode ser nulo
Status do cadastro: pending, analyzing, awaiting-documents, active, disabled…
documentsobjectobrigatório
Os documentos de KYC da sub-conta.
+3 campos de documents
- completebooleanobrigatório
  Se todos os documentos exigidos foram aceitos.
- documentTypestringobrigatóriopode ser nulo
  Se o vendedor se cadastra como pessoa (cpf) ou empresa (cnpj); null antes do passo 1.
  Valores:cpfcnpj
- requirementsobject[]obrigatório
  O que o passo 3 precisa entregar, e em que pé está cada exigência.
  +5 campos de requirements
  - keystringobrigatório
    O que é exigido (ex.: identity, proofOfAddress).
  - statusstringobrigatório
    Estado da exigência (missing, pending, approved, rejected…).
  - subjectstringobrigatório
    De quem é o documento: do holder (a pessoa) ou da company.
    Valores:holdercompany
  - requiredbooleanobrigatório
    Se é obrigatório.
  - alternativesobject[]obrigatório
    Os tipos de documento que atendem à exigência — um basta.
    +3 campos de alternatives
    keystringobrigatório
    Tipo de documento que atende à exigência (ex.: cnh, rg).
    statusstringobrigatório
    Estado desta alternativa.
    documentsobject[]obrigatório
    Os documentos enviados para esta alternativa.
onboardingobjectobrigatório
Andamento dos passos do cadastro.
+3 campos de onboarding
- completedAtstringobrigatóriopode ser nulo
  Quando o último passo foi enviado; null até lá.
- currentStepstringobrigatório
  O passo em que o cadastro está.
- isCompletedbooleanobrigatório
  Se todos os passos foram enviados.
reviewDueAtstringobrigatóriopode ser nulo
Até quando a análise responde; null fora de uma análise.
lastStatusChangeobjectobrigatóriopode ser nulo
A última mudança de status; null quando não há.
+4 campos de lastStatusChange
- atstringobrigatório
  Quando.
- bystringobrigatório
  Quem mudou: staff (Selectwin), provider, seller, platform (você) ou system.
  Valores:staffprovidersellerplatformsystem
- tostringobrigatóriopode ser nulo
  O status novo.
- fromstringobrigatóriopode ser nulo
  O status anterior.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorReativa uma sub-conta que a sua plataforma suspendeu PróximaO pedido de exclusão atual de uma sub-conta, com o que ainda o bloqueia

{ "id": "bus_0a1b2c3d4e5f60718293", "status": "string", "documents": { "complete": true, "documentType": "cpf", "requirements": [ { "key": "string", "status": "string", "subject": "holder", "required": true, "alternatives": [ { "key": "string", "status": "string", "documents": [ {} ] } ] } ] }, "onboarding": { "completedAt": "string", "currentStep": "string", "isCompleted": true }, "reviewDueAt": "string", "lastStatusChange": { "at": "string", "by": "staff", "to": "string", "from": "string" } }