Envia o passo 1 do cadastro pelo link de credenciamento

POST/v1/marketplace/kyc/{token}/onboarding/step-1

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

countrystringobrigatório
Código do país (ISO 3166-1), convertido para maiúsculas no servidor.
revenueintegerobrigatório
Faturamento mensal declarado, em centavos (mínimo 5000).
inviteCodestring
Código de convite; obrigatório só quando o documentType escolhido não está aberto no cadastro (veja …/onboarding/document-types). Normalizado no servidor (maiúsculas, A-Z0-9); ignorado nos outros casos. Confira antes com …/onboarding/invite-code/validate.
documentTypestringobrigatório
cpf (pessoa física) ou cnpj (empresa). …/onboarding/document-types diz quais estão abertos no cadastro e quais precisam de código de convite.
Valores:cpfcnpj

Respostas

200Sucesso

idstringobrigatório
Identificador público (bus_…)
mccstringobrigatóriopode ser nulo
Código de categoria do estabelecimento (MCC); null até ser definido.
logostringobrigatóriopode ser nulo
URL do logotipo; null quando nenhum foi enviado.
namestringobrigatório
Nome fantasia da empresa (o que os compradores veem).
emailstringobrigatóriopode ser nulo
E-mail de contato da empresa; null até o passo 4.
_linksobjectobrigatório
Links para esta empresa e para o onboarding dela.
+2 campos de _links
- selfstringobrigatório
  URL desta empresa.
- onboardingstringobrigatório
  URL da visão do onboarding.
statusstringobrigatóriopode ser nulo
Status da conta (pending, analyzing, active, suspended…); null quando não definido.
countrystringobrigatóriopode ser nulo
Código do país (ISO 3166-1); null até o passo 1.
revenuenumberobrigatóriopode ser nulo
Faturamento mensal declarado, em centavos; null até o passo 1.
websitestringobrigatóriopode ser nulo
URL do site; null quando não há.
documentstringobrigatóriopode ser nulo
CPF ou CNPJ, só dígitos; null até o passo 2.
referrerstringobrigatóriopode ser nulo
Como a empresa conheceu a plataforma; null quando não informado.
cellphonestringobrigatóriopode ser nulo
Telefone de contato, só dígitos; null até o passo 4.
createdAtstringobrigatório
Quando o recurso foi criado (ISO 8601, UTC).
updatedAtstringobrigatório
Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
onboardingobjectobrigatório
Andamento do onboarding.
+8 campos de onboarding
- overviewobjectobrigatório
  O que cada passo registrou (campos sensíveis mascarados).
- checklistobjectobrigatório
  Quais passos foram concluídos (checkListStep1Complete…checkListStep6Complete).
- inviteCodestringobrigatóriopode ser nulo
  O código de convite resgatado no passo 1; null quando não há.
- completedAtstringobrigatóriopode ser nulo
  Quando o onboarding foi concluído (ISO 8601); null até lá.
- currentStepstringobrigatório
  O passo em que o onboarding está (1 a 6).
- isCompletedbooleanobrigatório
  Se todos os passos foram concluídos.
- onboardingIdstringobrigatóriopode ser nulo
  Identificador público (cob_/onb_…)
- referralSourcestringobrigatóriopode ser nulo
  Como a empresa conheceu a plataforma; null quando não informado.
descriptionstringobrigatóriopode ser nulo
O que a empresa vende, nas palavras dela; null até o passo 6.
reviewDueAtstringpode ser nulo
Até quando a análise de KYC responde (ISO 8601); null quando a conta não está em análise ou não tem prazo. Só nas leituras.
documentTypestringobrigatóriopode ser nulo
cpf ou cnpj; null até o passo 1.
corporateCnaestringpode ser nulo
CNAE principal da empresa; null quando desconhecido; omitido nas leituras do lojista.
platformBrandbooleanobrigatório
Se os links dos e-mails enviados aos compradores levam a marca da plataforma (true) ou o domínio próprio da empresa (false, marca branca).
softdescriptorstringobrigatóriopode ser nulo
O que aparece na fatura do cartão do comprador; null até o passo 4.
corporateOpenDatestringpode ser nulo
Data de abertura da empresa (YYYY-MM-DD); null quando desconhecida; omitida nas leituras do lojista.
legalBusinessNamestringobrigatóriopode ser nulo
Razão social; null para pessoa física (CPF).
legalRepresentativeobjectpode ser nulo
O representante legal vigente; null quando a empresa não tem; omitido nas leituras do lojista.
+6 campos de legalRepresentative
- documentstringobrigatóriopode ser nulo
  CPF, mascarado a menos que revelado.
- lastNamestringobrigatóriopode ser nulo
  Sobrenome.
- redactedbooleanobrigatório
  Se os campos estão mascarados.
- birthDatestringobrigatóriopode ser nulo
  Data de nascimento (YYYY-MM-DD); null quando mascarada.
- birthYearintegerobrigatóriopode ser nulo
  Ano de nascimento.
- firstNamestringobrigatóriopode ser nulo
  Nome.
paymentGroupsBlockedboolean
Se os pagamentos combinados (dois cartões, cartão + Pix) estão bloqueados para esta empresa; omitido nas leituras do lojista.
monthlyBillingEstimatestringobrigatóriopode ser nulo
Volume mensal de vendas esperado, em centavos (como texto); null até o passo 6.

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

422Regra de negócio impede o processamento

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

AnteriorPede um upload pré-assinado de documento pelo link de credenciamento PróximaEnvia o passo 2 do cadastro pelo link de credenciamento

Requisição

curl -X POST "https://api.selectwin.io/v1/marketplace/kyc/{token}/onboarding/step-1" \
  -H "SelectKey: $SELECTWIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "country": "string",
  "revenue": 5000,
  "inviteCode": "string",
  "documentType": "cpf"
}'

Resposta

{
  "id": "bus_0a1b2c3d4e5f60718293",
  "mcc": "string",
  "logo": "string",
  "name": "Acme Ltda",
  "email": "buyer@example.com",
  "_links": {
    "self": "string",
    "onboarding": "string"
  },
  "status": "string",
  "country": "string",
  "revenue": 0,
  "website": "string",
  "document": "string",
  "referrer": "string",
  "cellphone": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "onboarding": {
    "overview": {},
    "checklist": {},
    "inviteCode": "string",
    "completedAt": "string",
    "currentStep": "string",
    "isCompleted": true,
    "onboardingId": "cob_0a1b2c3d4e5f60718293",
    "referralSource": "string"
  },
  "description": "string",
  "reviewDueAt": "string",
  "documentType": "string",
  "corporateCnae": "string",
  "platformBrand": true,
  "softdescriptor": "string",
  "corporateOpenDate": "string",
  "legalBusinessName": "string",
  "legalRepresentative": {
    "document": "string",
    "lastName": "Silva",
    "redacted": true,
    "birthDate": "1990-05-20",
    "birthYear": 0,
    "firstName": "João"
  },
  "paymentGroupsBlocked": true,
  "monthlyBillingEstimate": "string"
}