Histórico da Página

...

PARÂMETRO

TIPO

TAMANHO

OBRIGATÓRIO

DESCRIÇÃO

Identification

Object Json

True

Informações do tipo de identificação do cliente

Parâmetro

Tipo

Descrição

Document

String

Número do documento de
identificação da pessoa

DocumentType

String

Tipo de documento de identificação

cdtIDInternal - Código interno

cdtCPF - CFP

cdtCNPJ - CNPJ

cdtIDForeign - Identificador único

Name

String

50

True

Nome / Razão social

Kind

String

True

Tipo de pessoa

cktPhysical - Física
cktLegal - Jurídica

Taxpayer

String

False

Contribuinte de ICMS

yntYes - Sim
yntNo - Não

PublicAgency

String

False

Órgão público

yntYes - Sim
yntNo - Não

TaxRegime

Integer

5

False

Regime de tributação

GlobalLimit

Double

9, 2

False

Valor limite global

Deadline

Integer

3

False

Prazo máximo em dias

CreditStatus

String

False

Situação do crédito

ccsAlert - Alerta
ccsReleased - Liberado
ccsBlocked - Bloqueado
ccsSuspended - Suspenso

Note

String

250

False

Observação

CardNumber

Integer

15

False

Número do cartão

BusinessSituation

String

False

Situação comercial

bstReleased - Liberado
bstBlocked - Bloqueado

KindAddress

String

True

Tipo do endereço

katMain - Principal
katCharge - Cobrança
katDelivery - Entrega
katCorrespondence - Correspondência
katPickUp - Retirada

PublicPlace

String

60

True

Descrição do logradouro

PublicPlaceNumber

String

10

False

Número do logradouro

Neighbourhood

String

50

True

Descrição do bairro

Complement

String

60

False

Complemento de endereço

City

String

60

True

Nome da cidade

FederativeUnit

String

2

True

Estado da cidade

ZipCode

Integer

8

True

Cep sem formatação

IBGE

Integer

12

False

Código da cidade no IBGE

Request Exemplo

{
"id":"{E20B5192-1CDB-4F92-99C4-BB0F8CD700DB}",
"version":1,
"identification":{
"document":"11111111111",
"documentType":"cdtCPF"
}
}

Response Example

...

Formatos de Resposta (Response Formats)

application/json

Exemplosimplificado(Sample)

Bloco de código

language	actionscript3

{
  "id":"

...

527dd979-

...

6f51-

...

4046-

...

a6a7-

...

a8e20c4a6a54",

...


  "version": 1,

...


  "person":{

...


    "identification":{

...


      "document":"

...

12345678909",
      "documentType":"cdtCPF"

...


    },
    "Name":"

...

NOME SOBRENOME2",
    "kind":"

...

cktPhysical",

...


    "addresses":[
      {
        "kindAddress":"katMain",
        "publicPlace":"RUA 00",
        "publicPlaceNumber":"123",
        "neighbourhood":"JARDRIM TESTE",
        "complement":"",
        "city":"CIDADE TESTE",
        "federativeUnit":"SP",
        "zipCode":"12344809",
        "iBGE":1234
      }
    ]
  }
}

application/json

Exemplocompleto(Sample)

Bloco de código

language	actionscript3

{
  "id":"527dd979-6f51-4046-a6a7-a8e20c4a6a54",
  "version": 1,
  "person":{
    "identification":{
      "document":"12345678909",
      "documentType":"cdtCPF"
    },
    "Name":"NOME SOBRENOME2",
    "kind":"cktPhysical",
    "taxpayer":"yntYes",
    "publicAgency":"yntYes",
    "customer":{
      "globalLimit":0,
      "deadline":0,
      "creditStatus":"ccsAlert",
      "note":"",
      "cardNumber":0,
      "businessSituation":"bstReleased"
    },
    "addresses":[
      {
        "kindAddress":"katMain",
        "publicPlace":"RUA 00",
        "publicPlaceNumber":"123",
        "neighbourhood":"JARDRIM TESTE",
        "complement":"",
        "city":"CIDADE TESTE",
        "federativeUnit":"SP",
        "zipCode":"12344809",
        "iBGE":1234
      }
    ]
  }
}

Árvore de páginas

Versões comparadas

Versão antiga 24

Nova versão 25

Chave

Request Exemplo

Response Example

Formatos de Resposta (Response Formats)

application/json

application/json