Customers

Uma lista de clientes.

hasMoreboolean

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

Array [

idstring

Identificador exclusivo para o objeto.

Example: cust_5f92f01728e009f403d8502e

documentstring

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

Possible values: >= 11 characters and <= 11 characters

namestring

O nome completo do cliente ou o nome da empresa.

emailstring

O endereço de e-mail do cliente.

phonestring

O número de telefone do cliente.

usernamestring

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

address object

A especificação de um endereço

citystringrequired

Cidade ou distrito.

Example: São Paulo

statestringrequired

Estado, município, província ou região.

Example: SP

countrystringrequired

Código de país de duas letras (ISO 3166-1 alpha-2).

Example: BR

line1stringrequired

Linha de endereço 1 (por exemplo, rua, caixa postal).

Example: Av Paulista

line2string

Linha de endereço 2 (por exemplo, apartamento, suíte, unidade ou prédio).

Example: Sala 404

numberstringrequired

Número do endereço.

Example: 123

postalCodestringrequired

CEP ou Código postal.

Example: 12123123

neighborhoodstringrequired

Bairro.

Example: Bela Vista

birthDatedate

Data de nascimento do cliente.

birthPlacestring

Local de nascimento do cliente.

nationalityNationality (string)

Nacionalidade do cliente.

Possible values: [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]

genderstring

Gênero do cliente.

Possible values: [female, male, other, prefer_not_to_answer]

publicPersonboolean

Indentificador se o cliente é uma pessoa politicamente exposta.

maritalStatusstring

Estado civil do cliente.

Possible values: [single, married, widowed, divorced, separated]

motherNamestring

Nome da mãe do cliente.

additionalDocuments object[]

Documentos adicionais.

Array [

typestring

numberstring

issuerstring

stateState (string)

Estado

Possible values: [AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO]

]

attachments object[]

Array [

filestring

Example: file_6307b6c39f5d3d917009b631

linkedAtdate-time

]

metadataobject

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.

createdAtdate-time

Data de criação do objeto

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

updatedAtdate-time

Data de alteração do objeto

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

deletedboolean

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

Default value: false

Example: false

createdBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

]

Customers

{
  "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": "2024-07-29",
      "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": "2024-07-29T15:51:28.071Z"
        }
      ],
      "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"
      }
    }
  ]
}