The Blacklist Object

The Object

Attribute

Description

*id

stringrequired

It is a UUID v4 (36 characters long)

name

string

The name of the person on the blacklist

reason

string

Reason why this person is on the blacklist

*type

stringimmutable

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

phone

string

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

email

string

The email of the person

document

string

Applied to companies outside Brazil

cpf

string

Only applied to companies in Brazil

rg

string

Only applied to companies in Brazil

Short Sample

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

Available Methods

Table of Errors

Method

Type

Description

GET /blacklist

INVALID_QUERY_OPERATOR

INVALID_LIMIT_VALUE

INVALID_OFFSET_VALUE

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