Validación de número telefónico
El endpoint de validación de número telefónico se encarga de informar si un número telefónico es válido, así como su formato, país, operador y tipo de línea (móvil, fija, toll-free).
Método: POST
Endpoint
Sección titulada «Endpoint»https://api.verificamex.com/identity/v1/miscellaneous/phone-validationsEncabezados de la Solicitud
Sección titulada «Encabezados de la Solicitud»Para realizar la solicitud es necesario incluir los siguientes encabezados:
| Encabezado | Valor | Descripción |
|---|---|---|
| Accept | application/json | Tipo de contenido de la solicitud. |
| Authorization | Bearer {tu_token} | Token generado para autenticar al usuario. |
Cuerpo de la Solicitud
Sección titulada «Cuerpo de la Solicitud»El cuerpo de la solicitud debe contener los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
| phone_number | String | Número telefónico a validar, en formato internacional (con código de país, ej. +52). Máximo 15 caracteres. |
Ejemplo de cuerpo de la solicitud
Sección titulada «Ejemplo de cuerpo de la solicitud»{ "phone_number": "+525512345678"}Respuesta del Endpoint
Sección titulada «Respuesta del Endpoint»{ "data": { "object": "PhoneValidation", "id": 33, "result": { "valid": true, "number": "525512345678", "local_format": "5512345678", "international_format": "+525512345678", "country_prefix": "+52", "country_code": "MX", "country_name": "Mexico", "location": "Mexico City", "carrier": "Telcel", "line_type": "mobile", "message": "Número válido", "error_code": null, "error_type": null }, "created_at": "2024-10-12T19:13:48.000000Z", "updated_at": "2024-10-12T19:13:48.000000Z", "readable_created_at": "hace 1 segundo", "readable_updated_at": "hace 1 segundo" }, "meta": { "include": [], "custom": [] }}Este error ocurre si falta el parámetro phone_number o si no es una cadena de caracteres.
{ "message": "El campo phone number es obligatorio.", "errors": { "phone_number": [ "El campo phone number es obligatorio." ] }}