Regularidade do FGTS

{
  "$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}|[0-9A-Za-z]{12}\\d{2}|[0-9A-Za-z]{2}\\.[0-9A-Za-z]{3}\\.[0-9A-Za-z]{3}\\/[0-9A-Za-z]{4}-\\d{2})$",
      "description": "CPF ou CNPJ completo, com ou sem pontuação.",
      "title": "CPF ou CNPJ"
    },
    "parameters": {
      "default": {},
      "description": "Parâmetros adicionais exigidos pela certidão selecionada.",
      "type": "object",
      "properties": {
        "state": {
          "description": "Sigla da unidade federativa, com duas letras maiúsculas.",
          "type": "string",
          "pattern": "^[A-Z]{2}$"
        },
        "city": {
          "description": "Nome do município usado na consulta da certidão.",
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        "name": {
          "description": "Nome completo da pessoa ou razão social da empresa consultada.",
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "birth_date": {
          "description": "Data de nascimento no formato exigido pela certidão selecionada.",
          "type": "string",
          "maxLength": 10
        },
        "mother_name": {
          "description": "Nome completo da mãe.",
          "type": "string",
          "maxLength": 200
        },
        "father_name": {
          "description": "Nome completo do pai.",
          "type": "string",
          "maxLength": 200
        },
        "gender": {
          "description": "Gênero conforme os valores aceitos pela certidão selecionada.",
          "type": "string",
          "maxLength": 30
        },
        "identity_issue_state": {
          "description": "Sigla da UF de emissão do documento de identidade.",
          "type": "string",
          "pattern": "^[A-Z]{2}$"
        },
        "identity_issue_agency": {
          "description": "Órgão emissor do documento de identidade.",
          "type": "string",
          "maxLength": 40
        },
        "identity_issued_at": {
          "description": "Data de emissão do documento de identidade no formato exigido pela certidão.",
          "type": "string",
          "maxLength": 10
        },
        "birth_place": {
          "description": "Local de nascimento informado no documento de identidade.",
          "type": "string",
          "maxLength": 120
        },
        "date_format": {
          "description": "Formato usado nas datas informadas para a certidão.",
          "type": "string",
          "maxLength": 30
        },
        "municipality": {
          "type": "string",
          "maxLength": 140,
          "description": "Município-UF, por exemplo: São Paulo-SP."
        },
        "municipal_registration": {
          "description": "Número da inscrição municipal; exigido na certidão municipal_debt.",
          "type": "string",
          "maxLength": 40
        },
        "address_state": {
          "description": "Sigla da UF do endereço da pessoa ou empresa consultada.",
          "type": "string",
          "pattern": "^[A-Z]{2}$"
        },
        "active_debt": {
          "description": "Opção de consulta à dívida ativa aceita pela certidão; aplicável ao estado de São Paulo.",
          "type": "string",
          "maxLength": 20
        },
        "identity_number": {
          "description": "Número do documento de identidade; exigido na certidão criminal_state.",
          "type": "string",
          "maxLength": 30
        },
        "state_registration": {
          "description": "Número da inscrição estadual da empresa.",
          "type": "string",
          "maxLength": 30
        },
        "court": {
          "description": "Tribunal ou região exigido pela certidão selecionada.",
          "type": "string",
          "maxLength": 50
        },
        "type": {
          "description": "Modalidade da certidão, conforme os valores aceitos pelo tribunal selecionado.",
          "type": "string",
          "maxLength": 80
        },
        "zip_code": {
          "description": "CEP do endereço consultado.",
          "type": "string",
          "maxLength": 9
        },
        "street": {
          "description": "Nome do logradouro, sem o número.",
          "type": "string",
          "maxLength": 200
        },
        "street_type": {
          "description": "Tipo do logradouro, como rua ou avenida.",
          "type": "string",
          "maxLength": 40
        },
        "number": {
          "description": "Número do imóvel no endereço consultado.",
          "type": "string",
          "maxLength": 30
        },
        "neighborhood": {
          "description": "Bairro do endereço consultado.",
          "type": "string",
          "maxLength": 120
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "document"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "document": "19131243000197",
      "parameters": {}
    }
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "object": {
          "type": "string",
          "const": "business",
          "description": "Tipo do objeto: empresa."
        },
        "document": {
          "type": "string",
          "minLength": 1,
          "description": "CPF ou CNPJ informado pela fonte; pode estar mascarado."
        },
        "legal_name": {
          "type": "string",
          "minLength": 1,
          "description": "Razão social."
        },
        "trade_name": {
          "type": "string",
          "description": "Nome fantasia."
        },
        "registration_status": {
          "type": "string",
          "description": "Situação cadastral, preservada conforme a 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 cadastral, em YYYY-MM-DD."
        },
        "founded_at": {
          "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 abertura, em YYYY-MM-DD."
        },
        "legal_nature": {
          "type": "string",
          "description": "Natureza jurídica."
        },
        "size": {
          "type": "string",
          "description": "Porte da empresa."
        },
        "capital": {
          "type": "string",
          "pattern": "^-?\\d+(?:\\.\\d+)?$",
          "description": "Capital social em reais, como texto decimal, preservando a precisão informada."
        },
        "main_activity": {
          "type": "string",
          "description": "Atividade econômica principal."
        },
        "address": {
          "description": "Endereço cadastral, quando informado.",
          "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
        }
      },
      "required": [
        "object",
        "document",
        "legal_name"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "object": {
          "type": "string",
          "const": "certificate",
          "description": "Tipo do objeto: certidão."
        },
        "document": {
          "type": "string",
          "minLength": 1,
          "description": "CPF ou CNPJ informado pela fonte; pode estar mascarado."
        },
        "certificate_type": {
          "type": "string",
          "description": "Identificador da modalidade de certidão solicitada."
        },
        "status": {
          "type": "string",
          "description": "Situação textual informada na certidão."
        },
        "number": {
          "type": "string",
          "description": "Número ou protocolo da certidão."
        },
        "issued_at": {
          "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 emissão, em YYYY-MM-DD."
        },
        "expires_at": {
          "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 validade, em YYYY-MM-DD."
        },
        "has_occurrences": {
          "type": "boolean",
          "description": "Indicação de ocorrências na certidão."
        },
        "has_lawsuits": {
          "type": "boolean",
          "description": "Indicação de processos na certidão."
        },
        "validation_code": {
          "type": "string",
          "description": "Código de validação informado pela fonte."
        }
      },
      "required": [
        "object",
        "document",
        "certificate_type"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "object": {
          "type": "string",
          "const": "list",
          "description": "Coleção de objetos Base39."
        },
        "data": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "object": {
                "type": "string",
                "const": "certificate",
                "description": "Tipo do objeto: certidão."
              },
              "document": {
                "type": "string",
                "minLength": 1,
                "description": "CPF ou CNPJ informado pela fonte; pode estar mascarado."
              },
              "certificate_type": {
                "type": "string",
                "description": "Identificador da modalidade de certidão solicitada."
              },
              "status": {
                "type": "string",
                "description": "Situação textual informada na certidão."
              },
              "number": {
                "type": "string",
                "description": "Número ou protocolo da certidão."
              },
              "issued_at": {
                "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 emissão, em YYYY-MM-DD."
              },
              "expires_at": {
                "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 validade, em YYYY-MM-DD."
              },
              "has_occurrences": {
                "type": "boolean",
                "description": "Indicação de ocorrências na certidão."
              },
              "has_lawsuits": {
                "type": "boolean",
                "description": "Indicação de processos na certidão."
              },
              "validation_code": {
                "type": "string",
                "description": "Código de validação informado pela fonte."
              }
            },
            "required": [
              "object",
              "document",
              "certificate_type"
            ],
            "additionalProperties": false
          },
          "description": "Objetos da coleção."
        },
        "next_cursor": {
          "description": "Cursor opaco da próxima página; ausente ao final.",
          "type": "string"
        }
      },
      "required": [
        "object",
        "data"
      ],
      "additionalProperties": false
    }
  ],
  "type": "object",
  "examples": [
    {
      "object": "list",
      "data": [
        {
          "object": "certificate",
          "document": "19131243000197",
          "certificate_type": "fgts",
          "status": "NAO CONSTA",
          "number": "CERT-EXAMPLE",
          "expires_at": "2027-04-26"
        }
      ]
    }
  ]
}