Confere um código de convite pelo link de credenciamento — não consome

POST/v1/marketplace/kyc/{token}/onboarding/invite-code/validate

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).

Corpo da requisição

codestringobrigatório
O codigo digitado pelo lojista — normalizado no servidor
documentTypestring
O tipo de documento que o convite deve destravar (padrão cpf).
Valores:cpfcnpj

Respostas

200Sucesso

labelstringobrigatóriopode ser nulo
Sempre null. Mantido para clientes antigos.
validbooleanobrigatório
Se o código destrava o tipo de documento pedido.
reasonstringobrigatóriopode ser nulo
Sempre null: a resposta não diz por que um código não serve. Mantido para clientes antigos.
Valores:unknownrevokedexpiredexhaustednotForDocumentType
unlocksstring[]obrigatório
Tipos de documento que o convite destrava ([] quando não serve).
Valores:cpfcnpj
expiresAtstringobrigatóriopode ser nulo
Quando o convite expira (ISO 8601); null quando não expira, ou não serve.
remainingRedemptionsintegerobrigatóriopode ser nulo
Sempre null. Mantido para clientes antigos.

400Requisição inválida (validaçã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

AnteriorOs tipos de documento que o passo 1 pode escolher, pelo link de credenciamento PróximaConfirma o upload de um documento pelo link de credenciamento

Requisição

curl -X POST "https://api.selectwin.io/v1/marketplace/kyc/{token}/onboarding/invite-code/validate" \
  -H "SelectKey: $SELECTWIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string",
  "documentType": "cpf"
}'

Resposta

{
  "label": "string",
  "valid": true,
  "reason": "unknown",
  "unlocks": [
    "cpf"
  ],
  "expiresAt": "string",
  "remainingRedemptions": 0
}