Guia do desenvolvedor do e-KYC Now

Tipos de fluxo

Fluxo básico

Projetado para cenários de integração de baixo risco em que a velocidade é uma prioridade.
Esse fluxo verifica a autenticidade dos documentos de identidade emitidos pelo governo usando bancos de dados globais.

Premium Flow (mais seguro)

Nosso fluxo de verificação mais seguro.
Combina verificação de documentos com detecção biométrica de vivacidade e triagem de AML para melhorar a conformidade e a prevenção de fraudes.

Depois que o fluxo for criado, um ID de fluxo será gerado para os fluxos Básico e Premium.

Esse ID de fluxo é necessário para a integração da API e deve ser passado nos cabeçalhos da solicitação ao invocar as APIs KYC.

‍

Gerar chave de API

• Navegue até a seção Guia do desenvolvedor no console e clique em Gerar chave de API.
• Copie e armazene com segurança a chave de API gerada, pois ela será necessária para todas as solicitações de API.
• Mantenha a chave da API sempre confidencial; se ela for exposta, perdida ou comprometida, gere imediatamente uma nova chave.
• Observe que somente uma chave de API ativa é permitida por vez, e a geração de uma nova chave invalidará automaticamente a anterior.

Uso do fluxo de teste

Para fins de teste, você pode usar o recurso Trial Flow disponível no console.

• Para começar, copie a chave da API de teste da seção Guia do desenvolvedor.

Navegue até a página Gerenciar fluxos e clique no ícone “+” do fluxo desejado.

• Preencha os detalhes necessários e clique em Gerar. Após a geração bem-sucedida, um URL de redirecionamento KYC será fornecido.

Nota: O URL gerado é válido por apenas 30 minutos e deve ser usado estritamente para fins de teste. Não compartilhe esse URL, pois ele é de uso único e tem limite de tempo. Você tem apenas cinco (5) tentativas de teste gratuito permitidas. Cada vez que um URL de teste é gerado, uma tentativa de teste é consumida.

Exemplo de URL de teste

https://ekyc-staging.messagecentral.com/kyc/flow/aEzRTHuaJcwda4WtETc119_S-ljpyGpeo0aLzz4705w

Nota: Exemplos de URLs de teste são gerados com um Flow ID predefinido.

Não modifique nem substitua esse ID de fluxo por outro fluxo, pois isso pode resultar em erros inesperados e no consumo desnecessário de créditos de teste.

Gerar URL da API

Ponto final

POSTAR https://ekyc.messagecentral.com/ekyc/api/v1/redirection/generate-url

Autenticação, cabeçalhos e corpo

Você deve passar os seguintes cabeçalhos e corpo com cada solicitação:

Exemplos de cabeçalhos e corpo

flow_id: HFBiyuFQ 9o9AAUftbmkri9khpxlStafflbvg64jzim

api_key: Portador <YOUR API KEY>

nome_da_empresa: <YOUR COMPANY NAME>

Tipo de conteúdo: application/json

Exemplo de cURL

curl --location 'https://ekyc.messagecentral.com/ekyc/api/v1/redirection/generate-url' \

--header flow_id: FLOW_ID \

--header api_key: Bearer YOUR_API_KEY \

--form company_name="YOUR_COMPANY_NAME"

Nota: O flow_id e a api_key mostrados neste exemplo são apenas para fins de demonstração. Você deve substituí-los por seus próprios valores gerados a partir do console. Nunca exponha sua chave de API em aplicativos do lado do cliente.

Resposta

Resposta de sucesso (200 OK)

{

 "url": "https://ekyc.messagecentral.com/kyc/flow HfBIyufQ-9O9AauFtBMKRi9kHPXlStAfFlbvg64JzIM",

 "token": "HfBIyufQ-9O9AauFtBMKRi9kHPXlStAfFlbvg64JzIM",

 "journey_id": "M17682023316961BQG_SE",

 "expires_in_minutes": 30,

 "message": "Embed this URL in your application for KYC verification"

}

Campos de resposta explicados

Nota: O URL gerado expira após o tempo especificado. Você deve regenerá-lo após a expiração.

Respostas de erro (401 não autorizadas)

1. Nome da empresa ausente

{
 "detail": "Missing company name in Header"
}

Certifique-se de que company_name esteja presente no corpo da solicitação.

2. Formato de chave de API inválido

{

 "detail": "API Key must be 'Bearer '"

}

Verifique se a chave da API está prefixada com Bearer.

3. ID de fluxo ausente

{

 "detail": "Missing flow_id header/query."

}

Certifique-se de que flow_id seja enviado nos cabeçalhos da solicitação.

Diretrizes de segurança e uso (importante)

Essa API deve ser chamada estritamente do seu servidor de back-end.

NÃO chame essa API de aplicativos front-end

Não chame essa API diretamente de:

• Navegador (React, Angular, Vue, etc.)
• Aplicativos móveis (Android/iOS)
• JavaScript do lado do cliente

Expor essa API no frontend pode vazar sua chave de API, o que pode levar ao acesso não autorizado e ao uso indevido.

Melhores práticas de segurança

Sempre armazene sua api_key em:

• Variáveis de ambiente
• Gerentes secretos (AWS Secrets Manager, Vault etc.)

Gire as chaves da API periodicamente

Regenere URLs somente quando necessário (os URLs têm limite de tempo)

Nota sobre limitação de taxa/abuso

Nota: Solicitações excessivas ou abusivas podem ter uma taxa limitada para garantir a estabilidade da plataforma.

Em caso de dúvidas e preocupações, entre em contato conosco!

support@messagecentral.com

https://www.messagecentral.com/

Perguntas frequentes