Cadastro

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "document": {
      "type": "string",
      "pattern": "^(?:\\d{11}|\\d{3}\\.\\d{3}\\.\\d{3}-\\d{2})$",
      "description": "CPF completo, com ou sem pontuação.",
      "title": "CPF"
    }
  },
  "required": [
    "document"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "document": "52998224725"
    }
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "const": "individual",
      "description": "Tipo do objeto: pessoa física."
    },
    "document": {
      "type": "string",
      "minLength": 1,
      "description": "CPF ou CNPJ informado pela fonte; pode estar mascarado."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "description": "Nome da pessoa."
    },
    "birth_date": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
      "description": "Data de nascimento, em YYYY-MM-DD."
    },
    "registration_status": {
      "type": "string",
      "description": "Situação do CPF informada pela fonte."
    },
    "status_date": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
      "description": "Data da situação do CPF, em YYYY-MM-DD."
    },
    "deceased": {
      "type": "boolean",
      "description": "Indicação de óbito informada pela fonte."
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "street": {
            "type": "string",
            "description": "Logradouro."
          },
          "street_type": {
            "type": "string",
            "description": "Tipo de logradouro."
          },
          "number": {
            "type": "string",
            "description": "Número do endereço."
          },
          "complement": {
            "type": "string",
            "description": "Complemento do endereço."
          },
          "neighborhood": {
            "type": "string",
            "description": "Bairro."
          },
          "postal_code": {
            "type": "string",
            "description": "Código postal."
          },
          "city": {
            "type": "string",
            "description": "Município."
          },
          "state": {
            "type": "string",
            "description": "Unidade federativa."
          },
          "country": {
            "type": "string",
            "description": "País informado pela fonte."
          },
          "active": {
            "type": "boolean",
            "description": "Indica se o endereço está ativo na fonte."
          }
        },
        "additionalProperties": false
      },
      "description": "Endereços retornados pela fonte."
    }
  },
  "required": [
    "object",
    "document",
    "name",
    "addresses"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "object": "individual",
      "document": "52998224725",
      "name": "Pessoa Exemplo",
      "birth_date": "1990-01-01",
      "registration_status": "REGULAR",
      "status_date": "2016-08-23",
      "deceased": false,
      "addresses": [
        {
          "street": "Rua Exemplo",
          "street_type": "R",
          "number": "000000",
          "complement": "Complemento Exemplo",
          "neighborhood": "Bairro Exemplo",
          "postal_code": "01001000",
          "city": "ITAJAI",
          "state": "SC",
          "country": "BRASIL",
          "active": false
        },
        {
          "street": "Rua Exemplo",
          "street_type": "R",
          "number": "000000",
          "complement": "Complemento Exemplo",
          "neighborhood": "Bairro Exemplo",
          "postal_code": "01001000",
          "city": "ITAJAI",
          "state": "SC",
          "country": "BRASIL",
          "active": false
        },
        {
          "street": "Rua Exemplo",
          "street_type": "R",
          "number": "000000",
          "complement": "Complemento Exemplo",
          "neighborhood": "Bairro Exemplo",
          "postal_code": "01001000",
          "city": "ITAJAI",
          "state": "SC",
          "country": "BRASIL",
          "active": false
        }
      ]
    }
  ]
}