Confira a documentação técnica da API SIM Swap
Detalhes da solução
- Versão: SIM Swap 0.4.0
- Autor: TIM Brazil
Para outros detalhes, confira o Swagger da API.
Conheça as funcionalidades
Operações do SIM Swap:
Check
Verifica se houve uma troca de SIM (chip) associada ao número consultado dentro de um período determinado (por padrão, até 6 meses retroativos).
Retrieve Date
Recupera a data exata em que ocorreu a última troca de SIM (chip) vinculada ao número informado.
Descubra os retornos da API
Retornos de sucesso
/Check
• Status: 200 | Código: OK
• Retorna se uma troca de chip ocorreu nos últimos 6 meses
• Swapped: true/false
/Retrieve Date
• Status: 200 | Código: OK
• Contém informações sobre quando ocorreu a alteração do SIM Card nos últimos 6 meses
• latestSIMChange: YYYY/MM/DD ou Null
Retornos de erro
503 - Serviço indisponível
• Status: 503
• Code: UNAVAILABLE
• Message: 'Service unavailable'
500 - Erro no servidor interno
• Status: 500
• Code: INTERNAL
• Message: 'Internal server error'
404 - O número de celular não foi encontrado
• Status: 404
• Code: SIM_SWAP.UNKNOWN_PHONE_NUMBER
• Message: ‘SIM Swap can't be checked because the phone number is unknown'
403 - Permissão negada, o cliente não tem permissão suficiente para a solicitação
• Status: 403
• Code: PERMISSION_DENIED
• Message: 'Operation not allowed: ...'
401 - A requisição não foi autenticada devido à credenciais ausentes, inválidas ou expiradas
• Status: 401
• Code: UNAUTHENTICATED
• Message: ‘Request not authenticated due to missing, invalid, or expired credentials’
400 - Argumento, corpo da requisição ou parâmetro de busca enviados pelo cliente são inválidos.
• Status: 400
• Code: INVALID_ARGUMENT message: 'Client specified an invalid argument, request body or query param'
Download API Swagger
