O que o passo 3 precisa pedir, pelo link de credenciamento

GET/v1/marketplace/kyc/{token}/onboarding/document-requirements

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

Parâmetros do caminho

tokenstringobrigatório
O token secreto do link de credenciamento (a credencial destas operações).

Respostas

200Sucesso

completebooleanobrigatório
Se toda exigência obrigatória tem uma alternativa enviada ou aprovada.
documentTypestringobrigatóriopode ser nulo
cpf ou cnpj (passo 1); null antes dele, quando só os documentos do titular são listados.
Valores:cpfcnpj
requirementsobject[]obrigatório
O que precisa ser enviado, e o estado de cada exigência.
+5 campos de requirements
- keystringobrigatório
  Id estável da exigência (identity, selfie, bank_statement_company…).
- statusstringobrigatório
  O estado mais avançado entre as alternativas: approved > pending > rejected > missing.
  Valores:missingpendingapprovedrejected
- subjectstringobrigatório
  De quem é o documento: holder (a pessoa — o lojista CPF ou o representante legal) ou company.
  Valores:holdercompany
- requiredbooleanobrigatório
  Se a exigência precisa ser cumprida.
- alternativesobject[]obrigatório
  QUALQUER alternativa satisfaz a exigência; uma alternativa precisa de TODOS os seus documentos.
  +3 campos de alternatives
  - keystringobrigatório
    Id estável: os tipos de documento da alternativa unidos por + (rg_front+rg_back).
  - statusstringobrigatório
    approved quando todos os documentos estão; rejected quando algum está; pending quando todos foram enviados; senão missing.
    Valores:missingpendingapprovedrejected
  - documentsobject[]obrigatório
    Os documentos da alternativa.
    +7 campos de documents
    fileobjectobrigatório
    O que o arquivo precisa ser — a mesma regra que o anexo aplica.
    +2 campos de file
    maxBytesintegerobrigatório
    Tamanho máximo, em bytes (para todos os formatos listados).
    contentTypesstring[]obrigatório
    Tipos MIME aceitos.
    kindstringobrigatório
    O que o documento é (rg, cnh, cref, selfie, bank_statement…).
    sidestringobrigatório
    Qual parte do documento o arquivo contém: front, back ou full.
    Valores:frontbackfull
    typestringobrigatório
    O documentType a enviar no passo 3.
    statusstringobrigatório
    Estado do documento mais recente deste tipo que a empresa enviou; missing quando não há.
    Valores:missingpendingapprovedrejected
    documentIdstringobrigatóriopode ser nulo
    Id desse documento; null quando não há.
    rejectionReasonstringobrigatóriopode ser nulo
    Por que foi rejeitado; null nos outros casos.
unclassifiedobject[]obrigatório
Documentos enviados sob um tipo legado que não diz o que são; não satisfazem nenhuma exigência até serem classificados na aprovação.
+4 campos de unclassified
- typestringobrigatório
  O tipo legado sob o qual foi enviado.
- statusstringobrigatório
  O estado dele.
  Valores:pendingapprovedrejected
- documentIdstringobrigatório
  Id do documento.
- rejectionReasonstringobrigatóriopode ser nulo
  Por que foi rejeitado; null nos outros casos.
captureQualityobjectobrigatório
A régua que a foto de um documento deve passar — para a tela avisar enquanto a pessoa ainda pode tirar outra. Consultiva: uma foto abaixo dela ainda é aceita.
+9 campos de captureQuality
- darkLevelintegerobrigatório
  Nível de cinza até o qual um pixel conta como escuro.
- detailSideintegerobrigatório
  Lado do quadrado em que a imagem em tons de cinza é reduzida para caber (nunca ampliada) antes de medir nitidez e exposição, em pixels.
- brightLevelintegerobrigatório
  Nível de cinza a partir do qual um pixel conta como claro.
- minSharpnessnumberobrigatório
  Nitidez mínima: a variância do laplaciano de 4 vizinhos sobre o interior da imagem reduzida.
- minShortSideintegerobrigatório
  Comprimento mínimo do lado menor da imagem original, em pixels.
- maxDarkFractionnumberobrigatório
  Fração máxima de pixels escuros (0–1).
- maxBrightFractionnumberobrigatório
  Fração máxima de pixels claros (0–1).
- maxMeanBrightnessnumberobrigatório
  Nível médio de cinza máximo (0–255).
- minMeanBrightnessnumberobrigatório
  Nível médio de cinza mínimo (0–255).

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

AnteriorConfirma o upload de um documento pelo link de credenciamento PróximaLista os planos de taxas

Requisição

curl -X GET "https://api.selectwin.io/v1/marketplace/kyc/{token}/onboarding/document-requirements" \
  -H "SelectKey: $SELECTWIN_API_KEY"

Resposta

{
  "complete": true,
  "documentType": "cpf",
  "requirements": [
    {
      "key": "string",
      "status": "missing",
      "subject": "holder",
      "required": true,
      "alternatives": [
        {
          "key": "string",
          "status": "missing",
          "documents": [
            {
              "file": {
                "maxBytes": 0,
                "contentTypes": []
              },
              "kind": "string",
              "side": "front",
              "type": "string",
              "status": "missing",
              "documentId": "string",
              "rejectionReason": "string"
            }
          ]
        }
      ]
    }
  ],
  "unclassified": [
    {
      "type": "string",
      "status": "pending",
      "documentId": "string",
      "rejectionReason": "string"
    }
  ],
  "captureQuality": {
    "darkLevel": 0,
    "detailSide": 0,
    "brightLevel": 0,
    "minSharpness": 0,
    "minShortSide": 0,
    "maxDarkFraction": 0,
    "maxBrightFraction": 0,
    "maxMeanBrightness": 0,
    "minMeanBrightness": 0
  }
}