Customers

Uma lista de clientes.

hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

data

object[]

Uma lista de clientes

Este objeto representa um cliente.

data.id

string

Identificador exclusivo para o objeto.

Example:

"cust_5f92f01728e009f403d8502e"

data.document

string

Documento de identificação do cliente. Deve ser o CPF.

Required string length: 11

data.name

string

O nome completo do cliente ou o nome da empresa.

data.email

string

O endereço de e-mail do cliente.

data.phone

string

O número de telefone do cliente.

data.username

string

Nome de usuário para login. Pode ser qualquer valor único.

data.address

object

A especificação de um endereço

data.birthDate

string

Data de nascimento do cliente.

data.birthPlace

string

Local de nascimento do cliente.

data.nationality

enum<string>

Nacionalidade do cliente.

Available options:

AF,

ZA,

AL,

DE,

AD,

AO,

AI,

AQ,

AG,

SA,

DZ,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BO,

BA,

BW,

BR,

BN,

BG,

BF,

BI,

BT,

CV,

CM,

KH,

CA,

IC,

KZ,

EA,

TD,

CL,

CN,

CY,

SG,

CO,

KM,

CG,

KP,

KR,

CI,

CR,

HR,

CU,

CW,

DG,

DK,

DJ,

DM,

EG,

SV,

AE,

EC,

ER,

SK,

SI,

ES,

US,

EE,

ET,

FJ,

PH,

FI,

FR,

GA,

GM,

GH,

GE,

GI,

GB,

GD,

GR,

GL,

GP,

GU,

GT,

GG,

GY,

GF,

GN,

GQ,

GW,

HT,

NL,

HN,

HK,

HU,

YE,

BV,

AC,

CP,

IM,

CX,

PN,

RE,

AX,

KY,

CC,

CK,

FO,

GS,

HM,

FK,

MP,

MH,

UM,

NF,

SB,

SC,

TK,

TC,

VI,

VG,

IN,

ID,

IR,

IQ,

IE,

IS,

IL,

IT,

JM,

JE,

JO,

KI,

XK,

KW,

LA,

LS,

LV,

LB,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MY,

MW,

MV,

ML,

MT,

MA,

MQ,

MU,

MR,

YT,

MX,

FM,

MZ,

MD,

MC,

MN,

ME,

MS,

MM,

NA,

NR,

NP,

NI,

NE,

NG,

NU,

NO,

NC,

NZ,

OM,

BQ,

PW,

PS,

PA,

PG,

PK,

PY,

PE,

PF,

PL,

PR,

PT,

QA,

KE,

KG,

CF,

CD,

DO,

CZ,

RO,

RW,

RU,

EH,

PM,

AS,

WS,

SM,

SH,

LC,

BL,

KN,

MF,

SX,

ST,

VC,

SN,

SL,

RS,

SY,

SO,

LK,

SZ,

SD,

SS,

SE,

CH,

SR,

SJ,

TJ,

TH,

TW,

TZ,

IO,

TF,

TL,

TG,

TO,

TT,

TA,

TN,

TM,

TR,

TV,

UA,

UG,

UY,

UZ,

VU,

VA,

VE,

VN,

WF,

ZM,

ZW

data.gender

enum<string>

Gênero do cliente.

Available options:

female,

male,

other,

prefer_not_to_answer

data.publicPerson

boolean

Indentificador se o cliente é uma pessoa politicamente exposta.

data.maritalStatus

enum<string>

Estado civil do cliente.

Available options:

single,

married,

widowed,

divorced,

separated

data.motherName

string

Nome da mãe do cliente.

data.additionalDocuments

object[]

Documentos adicionais.

data.attachments

object[]

data.metadata

object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.deleted

boolean

default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

data.createdBy

object

data.updatedBy

object

Customer Employment

Copy
{
  "hasMore": true,
  "data": [
    {
      "id": "cust_5f92f01728e009f403d8502e",
      "document": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "username": "<string>",
      "address": {
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "line1": "Av Paulista",
        "line2": "Sala 404",
        "number": "123",
        "postalCode": "12123123",
        "neighborhood": "Bela Vista"
      },
      "birthDate": "2023-12-25",
      "birthPlace": "<string>",
      "nationality": "AF",
      "gender": "female",
      "publicPerson": true,
      "maritalStatus": "single",
      "motherName": "<string>",
      "additionalDocuments": [
        {
          "type": "<string>",
          "number": "<string>",
          "issuer": "<string>",
          "state": "AC"
        }
      ],
      "attachments": [
        {
          "file": "file_6307b6c39f5d3d917009b631",
          "linkedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos