Os tipos de documento que o passo 1 pode escolher, pelo link de credenciamento

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

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

allowedstring[]obrigatório
O que a empresa pode escolher AGORA no passo 1: os tipos abertos mais o que ela já destravou.
Valores:cpfcnpj
acceptedstring[]obrigatório
Os tipos de documento abertos no cadastro da plataforma.
Valores:cpfcnpj
redeemedInviteobjectobrigatóriopode ser nulo
O convite que a empresa já resgatou; null quando não há.
+4 campos de redeemedInvite
- codestringobrigatório
  O código, normalizado.
- unlocksstring[]obrigatório
  Tipos de documento que ele destrava.
  Valores:cpfcnpj
- redeemedAtstringobrigatório
  Quando foi resgatado (ISO 8601).
- documentTypestringobrigatório
  O tipo de documento para o qual foi resgatado.
  Valores:cpfcnpj
inviteUnlockablestring[]obrigatório
Tipos de documento fechados no cadastro, mas destravados por código de convite.
Valores:cpfcnpj

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

AnteriorRevoga o link de credenciamento (KYC) de uma sub-conta PróximaConfere um código de convite pelo link de credenciamento — não consome

Requisição

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

Resposta

{
  "allowed": [
    "cpf"
  ],
  "accepted": [
    "cpf"
  ],
  "redeemedInvite": {
    "code": "string",
    "unlocks": [
      "cpf"
    ],
    "redeemedAt": "string",
    "documentType": "cpf"
  },
  "inviteUnlockable": [
    "cpf"
  ]
}