Clarisa ofrece una API que le permite a su sistema integrarse y consultar los datos de una persona en el portal de la DIAN
La acción disponible de la API para consulta de una persona traerá razón social y correo en base al tipo y número documento de identificación.
Antes de continuar:
Para utilizar cualquier servicio de la API, es importante contar con un token de autenticación y autorización. Si necesita asistencia para obtenerlo, consulte la documentación detallada que se indica en el siguiente link.
https://ayuda.clarisa.co/guia-para-consumir-api-de-login/
Importante !
Para la consulta masiva de personas , es decir mas de uno, se debe enviar cada petición con intervalo de 5 segundos como mínimo para evitar el cruce de peticiones.
Consulta Persona
CABECERAS:
| CABECERA | VALOR |
| Content-Type | application/json |
| Authorization | token de usuario |
METODO: "GET"
Parametros de URL (QueryParam):
| LLAVE | VALOR | DESCRIPCIÓN |
| tipoIdentificacion | CC | Corresponde al Tipo de documento identificación que se desea consultar. |
| numIdentificacion | 12345 | Corresponde a el Número del documento identificación, que se desea consultar. |
https://pru.clarisacloud.com:8443/api/comun/rest/v1/consulta/dianTerceros?tipoIdentificacion=CC&numIdentificacion=12345
Petición:
| Nombre | Codigo |
|---|---|
| Cédula de ciudadanía | CC |
| NIT | NI |
| Registro civil | RC |
| Tarjeta de identidad | TI |
| Tarjeta de extranjería | TE |
| Cédula de extranjería | CE |
| Pasaporte | PA |
| Documento de identificación extranjero | DE |
| Permiso Especial de Permanencia | PE |
| Permiso de Protección Temporal | PT |
| Nit de otro país | NO |
| NUIP | NU |
Respuesta:
| Nombre | Tipo dato | Descripción |
|---|---|---|
| data | Alfanumérico | Contiene el uuid, estado del documento y fecha validación |
| lastAction | Alfanumérico | Nombre de la acción bajo la cual se respondió esta respuesta |
| success | Booleano | Determina si la operación fué exitosa o no |
| textResponse | Alfanumérico | Texto de la respuesta |
| titleResponse | Alfanumérico | Título de la respuesta |
Respuesta TOKEN
Tiene una vigencia de 12 horas, por favor
recuerde utilizar el token asignado en el login, para poder acceder a la API de documento electrónico.
Correcto
En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:
CÓDIGO HTTP: 200
Incorrecto
Si la solicitud no es correcta, recibirá la siguiente respuesta:
CÓDIGO HTTP: 400