Financial Info

Description

Verifiy the financial information from Credit Bureau

HTTP method GET

Endpoint

https://8ehec73psb.execute-api.us-west-2.amazonaws.com/uat/identity/api/idv-govcheck/v1/ar-identity/{CUIL}/financial-info

Request header parameter

NAME	REQUIRED	TYPE	DESCRIPTION
Authorization	✅	string	bearer jwt token

URI request parameter

NAME	REQUIRED	TYPE	DESCRIPTION
CUIL number	✅	string	Argentina labor identification number

Status code responses

Code	Description
200	OK
400	Bad request
401	Unauthorized
404	Not found
500	Internal server error.

The full documentation error codes can be found here.

Response 200 status code

{
    "traceId": "b2345cfc7bee621e",
    "timestamp": "2023-05-15 11:59:35",
    "data": {
        "score": 0,
        "puntaje": 0,
        "verazEnabled": true,
        "veraz": {
            "cantObsVigBa24m": 0,
            "categoria": "string",
            "documento": "string",
            "incomePredictor": "string",
            "incomePredictorRango": "string",
            "incomePredictorTexto": "string",
            "mensaje": "string",
            "montoObsVigBa24m": 0,
            "nombre": "string",
            "obsVigentesBa": [
                {
                    "codigoEntidad": "string",
                    "fecha": "2023-10-13",
                    "monto": 0,
                    "nombreEntidad": "string"
                }
            ],
            "ok": true,
            "scoreRango": 0,
            "scoreSegmento": "string",
            "scoreTexto": "string",
            "sexo": "M",
            "tokenCA": "string",
            "uuidLogConsulta": "string",
            "sujetoObligado": {
                "estado": "string",
                "fechaCreacion": "2023-10-13",
                "habilitado": true,
                "mensaje": "string",
                "tipoSujeto": "string"
            }
        }
    }
}

Response 400 status code

{
    "traceId": "542fc743fffda052",
    "timestamp": "2023-05-05 11:20:46",
    "code": "IDV-4005",
    "message": "-",
    "data": null
}

Response 401 status code

{
    "timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
    "status": 401,
    "error": "Unauthorized",
    "path": "/api/idv-govcheck/v1/ar-identity/{CUIL}/financial-info"
}

Response 500 status code

{
    "traceId": "43a20f33d4e8730d",
    "timestamp": "yyyy-mm-dd HH:MM:SS",
    "code": "IDV-1001",
    "message": "A generic error has occurred.",
    "data": null
}