Phone Risk

Description

Validate the phone number.

HTTP method POST

Endpoint

https://8ehec73psb.execute-api.us-west-2.amazonaws.com/uat/identity/api/govchecks/v1/br/report

info

Before proceeding, make sure you have your jwt token, if you don't, check the login documentation.

Request header parameter

NAME	REQUIRED	TYPE	DESCRIPTION
Authorization	✅	string	bearer jwt token

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.

Request body

NAME	REQUIRED	TYPE	FORMAT	DESCRIPTION
cpfNumber	✅	string	NNNNNNNNNNN	The CPF number is the Brazilian individual taxpayer registry and use 11 digits, where the last two digits are check digits.
sourceCode	✅	string	-	It is the source code and it only has only 2 supported values SCORE_EMAIL and PHONE_RISK.
phoneNumber	✅	string	NNNNNNNNN	The Brazilian telephone numbering uses a two-digit area plus eight-digit local phone numbers for landlines.
dddNumber	✅	string	NN	Area code.

Request body example

{
    "cpfNumber": "96583320134",
    "dddNumber": "66",
    "phoneNumber": "96027759",
    "sourceCode": "PHONE_RISK"
}

Response 200 status code

{
    "traceId": "b17baf7bff3041c4",
    "timestamp": "2023-02-14 21:32:12",
    "data": {
        "reportId": "b7a94ccf-6407-4743-8679-f9e55e746798"
    }
}

Response 400 status code

{
    "traceId": "542fc743fffda052",
    "timestamp": "2023-05-05 11:20:46",
    "code": "IDV-4005",
    "message": "sourceCode missing, allowed: FEDEREAL_PRESCRIPTION, BUSSINES_RELATIONS, SOCIAL_DATA, FEDERAL_POLICE, PROTESTOS, SCORE_EMAIL, SCORE_PHONE, VEHICLE_DATA. ",
    "data": null
}

Response 401 status code

{
    "timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ",
    "status": 401,
    "error": "Unauthorized",
    "path": "/api/govchecks/v1/br/report"
}

Response 500 status code

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