Envia o passo 2 do cadastro pelo link de credenciamento
/v1/marketplace/kyc/{token}/onboarding/step-2Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros do caminho
tokenstringobrigatórioO token secreto do link de credenciamento (a credencial destas operações).
Corpo da requisição
JSON livre.
Respostas
200Sucesso
idstringobrigatórioIdentificador público (bus_…)
mccstringobrigatóriopode ser nuloCódigo de categoria do estabelecimento (MCC);
nullaté ser definido.logostringobrigatóriopode ser nuloURL do logotipo;
nullquando nenhum foi enviado.namestringobrigatórioNome fantasia da empresa (o que os compradores veem).
emailstringobrigatóriopode ser nuloE-mail de contato da empresa;
nullaté o passo 4._linksobjectobrigatórioLinks para esta empresa e para o onboarding dela.
+2 campos de
_linksselfstringobrigatórioURL desta empresa.
onboardingstringobrigatórioURL da visão do onboarding.
statusstringobrigatóriopode ser nuloStatus da conta (
pending,analyzing,active,suspended…);nullquando não definido.countrystringobrigatóriopode ser nuloCódigo do país (ISO 3166-1);
nullaté o passo 1.revenuenumberobrigatóriopode ser nuloFaturamento mensal declarado, em centavos;
nullaté o passo 1.websitestringobrigatóriopode ser nuloURL do site;
nullquando não há.documentstringobrigatóriopode ser nuloCPF ou CNPJ, só dígitos;
nullaté o passo 2.referrerstringobrigatóriopode ser nuloComo a empresa conheceu a plataforma;
nullquando não informado.cellphonestringobrigatóriopode ser nuloTelefone de contato, só dígitos;
nullaté o passo 4.createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
updatedAtstringobrigatórioQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
onboardingobjectobrigatórioAndamento do onboarding.
+8 campos de
onboardingoverviewobjectobrigatórioO que cada passo registrou (campos sensíveis mascarados).
checklistobjectobrigatórioQuais passos foram concluídos (
checkListStep1Complete…checkListStep6Complete).inviteCodestringobrigatóriopode ser nuloO código de convite resgatado no passo 1;
nullquando não há.completedAtstringobrigatóriopode ser nuloQuando o onboarding foi concluído (ISO 8601);
nullaté lá.currentStepstringobrigatórioO passo em que o onboarding está (
1a6).isCompletedbooleanobrigatórioSe todos os passos foram concluídos.
onboardingIdstringobrigatóriopode ser nuloIdentificador público (cob_/onb_…)
referralSourcestringobrigatóriopode ser nuloComo a empresa conheceu a plataforma;
nullquando não informado.
descriptionstringobrigatóriopode ser nuloO que a empresa vende, nas palavras dela;
nullaté o passo 6.reviewDueAtstringpode ser nuloAté quando a análise de KYC responde (ISO 8601);
nullquando a conta não está em análise ou não tem prazo. Só nas leituras.documentTypestringobrigatóriopode ser nulocpfoucnpj;nullaté o passo 1.corporateCnaestringpode ser nuloCNAE principal da empresa;
nullquando desconhecido; omitido nas leituras do lojista.platformBrandbooleanobrigatórioSe 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 nuloO que aparece na fatura do cartão do comprador;
nullaté o passo 4.corporateOpenDatestringpode ser nuloData de abertura da empresa (
YYYY-MM-DD);nullquando desconhecida; omitida nas leituras do lojista.legalBusinessNamestringobrigatóriopode ser nuloRazão social;
nullpara pessoa física (CPF).legalRepresentativeobjectpode ser nuloO representante legal vigente;
nullquando a empresa não tem; omitido nas leituras do lojista.+6 campos de
legalRepresentativedocumentstringobrigatóriopode ser nuloCPF, mascarado a menos que revelado.
lastNamestringobrigatóriopode ser nuloSobrenome.
redactedbooleanobrigatórioSe os campos estão mascarados.
birthDatestringobrigatóriopode ser nuloData de nascimento (
YYYY-MM-DD);nullquando mascarada.birthYearintegerobrigatóriopode ser nuloAno de nascimento.
firstNamestringobrigatóriopode ser nuloNome.
paymentGroupsBlockedbooleanSe os pagamentos combinados (dois cartões, cartão + Pix) estão bloqueados para esta empresa; omitido nas leituras do lojista.
monthlyBillingEstimatestringobrigatóriopode ser nuloVolume mensal de vendas esperado, em centavos (como texto);
nullaté o passo 6.
400Requisição inválida (validação)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
422Regra de negócio impede o processamento
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório