Confira a documentação técnica da API Know Your Customer Match
Detalhes da solução
- Versão: Know Your Customer Match 0.1.0
- Autor: TIM Brazil
Para outros detalhes, confira o Swagger da API.
Conheça as funcionalidades
Operação da API Know Your Customer Match:
Match
Verifica se informações como nome, sobrenome, endereço, entre outros, correspondem à base de dados.
Descubra os retornos da API
Retornos de sucesso
/Match
• Status: 200 | Código: OK
• Confirma se o nome completo, data de nascimento, endereço, e-mail e CPF fornecidos pelo seu usuário correspondem aos dados da base TIM
• Output: true/false para cada campo
Retornos de erro
400 - Input inválido
• Status: 400
• Code: INVALID_ARGUMENT
• Message: 'Client specified an invalid argument, request body or query param'
400 - Parâmetros inválidos
• Status: 400
• Code: KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION
• Message: ‘Indicated parameter combination is invalid'
401 - Não autenticado
• Status: 401
• Code: UNAUTHENTICATED
• Message: ‘Request not authenticated due to missing, invalid, or expired credentials’
403 - Permissão negada
• Status: 403
• Code: PERMISSION_DENIED
• Message: ‘Client does not have sufficient permissions to perform this action’
404 - Não encontrado
• Status: 404
• Code: NOT_FOUND
• Message: ‘not_found_contractor/not_found’
405 - Sem permissão
• Status: 405
• Code: NOT_ALLOWED
• Message: ‘The requested HTTP method is not allowed for this resource’
500 - Erro no servidor interno
• Status: 500
• Code: INTERNAL
• Message: 'Server error'
503 - Serviço indisponível
• Status: 503
• Code: UNAVAILABLE
• Message: 'Service unavailable'
Download API Swagger
