The Blocked List Object

We decided to change the name from Blacklist to Blocked list. All the API methods will be available on both paths /blacklist and /blockedlist but we will deprecate the use of /blacklist on the v2.

IMPORTANT The field type will still be used with the value blacklist during v1.

The Object

Attribute

Description

*id

stringrequired

It is a UUID v4 (36 characters long)

name

string

The name of the person on the blocked list

reason

string

The reason why this person is on the blocked list

*type

stringimmutable

This is an immutable field that indicated the type of the object. In this case 'blacklist'

phone

string

The phone number of the person. This field only accepts numbers, e.g.: (43) 9 9982-0420 will be 43999820420

email

string

The email of the person

document

string

Applied to companies outside Brazil. This field only accepts numbers and letters

cpf

string

Only applied to companies in Brazil. It requires a valid CPF. This field only accepts numbers

rg

string

Only applied to companies in Brazil. This field only accepts numbers and letters

Short Sample

{
"id": "dc08c9dc-7aaa-4356-8268-f265b91a1624",
"name": "Alisson Enz Rossi",
"type": "blacklist",
}

Available Methods

Table of Errors

Method

Type

Description

GET

INVALID_QUERY_OPERATOR

INVALID_LIMIT_VALUE

INVALID_OFFSET_VALUE

POST

INVALID_CPF

CPF_ALREADY_EXISTS

RG_ALREADY_EXISTS

DOCUMENT_ALREADY_EXISTS

EMAIL_ALREADY_EXISTS

PHONE_ALREADY_EXISTS

DELETE GET PATCH

NOT_FOUND

DELETE GET PATCH

MISSING_ID

GET POST PATCH DELETE

INTERNAL

GET POST PATCH DELETE

BLACKLIST_DISABLED

GET POST PATCH DELETE

UNAUTHORIZED