> ## Documentation Index
> Fetch the complete documentation index at: https://docs-platform.services-valid.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# ID Check Composto

> Verifique a identidade de uma pessoa de maneira rápida e segura utilizando dados biográficos, biométricos, documentos e endereço em uma única operação

## Request Body

<ParamField body="identity" type="object" required>
  Dados de identificação mínima do titular. Obrigatório informar um tipo e valor do documento

  <Expandable title="propriedades">
    <ParamField body="type" type="string" required>
      Tipo de documento a ser verificado: cpf ou rnm.

      CPF: Cadastro de Pessoas Físicas

      RNM: Registro Nacional Migratório

      **Exemplo**: `cpf`
    </ParamField>

    <ParamField body="value" type="string" required>
      Número do documento do titular a ser verificado, relacionado ao tipo informado.

      **Exemplo**: `12345678900`
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="attributes" type="object" required>
  Conjunto de atributos utilizados na validação composta da identidade.

  <Expandable title="propriedades">
    <ParamField body="biographic" type="object">
      Dados biográficos do titular.

      <Expandable title="propriedades">
        <ParamField body="name" type="string">
          Nome civil informado para validação.

          **Exemplo**: `João da Silva`
        </ParamField>

        <ParamField body="socialName" type="string">
          Nome social informado para validação.

          **Exemplo**: `João Silva`
        </ParamField>

        <ParamField body="motherName" type="string">
          Nome da mãe informado para validação.

          **Exemplo**: `Maria da Silva`
        </ParamField>

        <ParamField body="fatherName" type="string">
          Nome do pai informado para validação.

          **Exemplo**: `José da Silva`
        </ParamField>

        <ParamField body="dateOfBirth" type="date">
          Data de nascimento do titular.

          **Exemplo**: `1990-01-01`
        </ParamField>

        <ParamField body="gender" type="string">
          Gênero informado para validação.

          **Exemplo**: `MALE`
        </ParamField>

        <ParamField body="nationality" type="string">
          Nacionalidade informada para validação.

          **Exemplo**: `BRAZILIAN`
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="biometrics" type="object">
      Dados biométricos utilizados na validação.

      <Expandable title="propriedades">
        <ParamField body="face" type="object">
          Dados da biometria facial.

          <Expandable title="propriedades">
            <ParamField body="image" type="string">
              Imagem facial em formato base64.

              **Exemplo**: `base64`
            </ParamField>

            <ParamField body="referenceImage" type="string">
              Imagem facial de refêrencia para comparação em formato base64.

              **Exemplo**: `base64`
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField body="fingerprints" type="array">
          Lista de impressões digitais a serem verificadas. Cada item representa uma digital com sua posição e imagem biométrica.

          <Expandable title="propriedades">
            <ParamField body="position" type="integer" required>
              Posição do dedo conforme tabela padrão NIST (1–10).

              1 - Polegar Direito

              2 - Indicador Direito

              3 - Médio Direito

              4 - Anelar Direito

              5 - Mínimo Direito

              6 - Polegar Esquerdo

              7 - Indicador Esquerdo

              8 - Médio Esquerdo

              9 - Anelar Esquerdo

              10 - Mínimo Esquerdo

              **Exemplo**: `1`
            </ParamField>

            <ParamField body="image" type="string" required>
              Imagem da digital em formato base64.

              **Exemplo**: `base64`
            </ParamField>
          </Expandable>
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="documents" type="object">
      Documentos utilizados na validação.

      <Expandable title="propriedades">
        <ParamField body="cpf" type="object">
          Dados do CPF informados para validação.

          <Expandable title="propriedades">
            <ParamField body="number" type="string">
              Número do CPF informado para validação.

              **Exemplo**: `12345678900`
            </ParamField>

            <ParamField body="status" type="string">
              Situação cadastral do CPF.

              **Exemplo**: `REGULAR`
            </ParamField>

            <ParamField body="registrationDate" type="date">
              Data de registro do CPF.

              **Exemplo**: `1990-01-01`
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField body="cnh" type="object">
          Dados da CNH informados para validação.

          <Expandable title="propriedades">
            <ParamField body="registrationNumber" type="string">
              Número de registro da CNH.

              **Exemplo**: `12345678900`
            </ParamField>

            <ParamField body="category" type="string">
              Categoria da CNH.

              **Exemplo**: `B`
            </ParamField>

            <ParamField body="status" type="string">
              Situação da CNH.

              **Exemplo**: `ISSUED`
            </ParamField>

            <ParamField body="foreignRegistration" type="string">
              Número de registro estrangeiro associado.

              **Exemplo**: `G123456`
            </ParamField>

            <ParamField body="firstIssueDate" type="date">
              Data da primeira emissão.

              **Exemplo**: `2010-01-15`
            </ParamField>

            <ParamField body="lastIssueDate" type="date">
              Data da última emissão.

              **Exemplo**: `2020-01-15`
            </ParamField>

            <ParamField body="expirationDate" type="date">
              Data de vencimento do documento.

              **Exemplo**: `2030-01-15`
            </ParamField>

            <ParamField body="hasRestriction" type="boolean">
              Indica se a CNH possui restrição.

              **Exemplo**: `false`
            </ParamField>

            <ParamField body="observations" type="string">
              Observações do documento.

              **Exemplo**: `EAR;A`
            </ParamField>

            <ParamField body="qrCode" type="string">
              Conteúdo do QR Code em base64.

              **Exemplo**: `base64`
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField body="rg" type="object">
          Dados do RG informados para validação.

          <Expandable title="propriedades">
            <ParamField body="number" type="string">
              Número do RG.

              **Exemplo**: `12345678`
            </ParamField>

            <ParamField body="issuer" type="string">
              Órgão emissor do RG.

              **Exemplo**: `SSP`
            </ParamField>

            <ParamField body="issuerState" type="string">
              Unidade federativa do emissor.

              **Exemplo**: `SP`
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField body="ctps" type="object">
          Dados da CTPS informados para validação.

          <Expandable title="propriedades">
            <ParamField body="number" type="string">
              Número da CTPS.

              **Exemplo**: `12345678`
            </ParamField>

            <ParamField body="issuer" type="string">
              Órgão emissor da CTPS.

              **Exemplo**: `SSP`
            </ParamField>

            <ParamField body="issuerState" type="string">
              Unidade federativa do emissor.

              **Exemplo**: `SP`
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField body="passport" type="object">
          Dados do passaporte informados para validação.

          <Expandable title="propriedades">
            <ParamField body="number" type="string">
              Número do passaporte.

              **Exemplo**: `12345678`
            </ParamField>

            <ParamField body="issuer" type="string">
              Órgão emissor do passaporte.

              **Exemplo**: `SSP`
            </ParamField>

            <ParamField body="issuerState" type="string">
              Unidade federativa do emissor.

              **Exemplo**: `SP`
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField body="militaryService" type="object">
          Dados do documento militar informados para validação.

          <Expandable title="propriedades">
            <ParamField body="number" type="string">
              Número do documento militar.

              **Exemplo**: `12345678`
            </ParamField>

            <ParamField body="issuer" type="string">
              Órgão emissor do documento militar.

              **Exemplo**: `SSP`
            </ParamField>

            <ParamField body="issuerState" type="string">
              Unidade federativa do emissor.

              **Exemplo**: `SP`
            </ParamField>
          </Expandable>
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="address" type="object">
      Endereço informado para validação.

      <Expandable title="propriedades">
        <ParamField body="street" type="string">
          Logradouro informado para validação.

          **Exemplo**: `Rua das Flores`
        </ParamField>

        <ParamField body="number" type="string">
          Número do endereço.

          **Exemplo**: `123`
        </ParamField>

        <ParamField body="complement" type="string">
          Complemento do endereço.

          **Exemplo**: `Apto 45`
        </ParamField>

        <ParamField body="neighborhood" type="string">
          Bairro informado para validação.

          **Exemplo**: `Centro`
        </ParamField>

        <ParamField body="postalCode" type="string">
          CEP informado para validação.

          **Exemplo**: `01001000`
        </ParamField>

        <ParamField body="city" type="string">
          Cidade informada para validação.

          **Exemplo**: `São Paulo`
        </ParamField>

        <ParamField body="state" type="string">
          Estado informado para validação.

          **Exemplo**: `SP`
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

## Response

<ResponseField name="scanId" type="string">
  Identificador interno da transação.

  **Exemplo**: `123e4567-e89b-12d3-a456-426614174000`
</ResponseField>

<ResponseField name="identity" type="object">
  Dados do documento consultado

  <Expandable title="propriedades">
    <ResponseField name="type" type="string">
      Tipo de documento verificado: cpf ou rnm.

      **Exemplo**: `cpf`
    </ResponseField>

    <ResponseField name="value" type="boolean">
      Indica se o documento foi encontrado e validado

      **Exemplo**: `true`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="attributes" type="object">
  Resultado consolidado das validações executadas.

  <Expandable title="propriedades">
    <ResponseField name="biographic" type="object">
      Resultado das validações de dados biográficos.

      <Expandable title="propriedades">
        <ResponseField name="name" type="boolean">
          Indica se o nome civil foi validado com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="nameSimilarity" type="double">
          Grau de similaridade calculado para o nome civil informado.

          **Exemplo**: `9.8`
        </ResponseField>

        <ResponseField name="socialName" type="boolean">
          Indica se o nome social foi validado com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="socialNameSimilarity" type="double">
          Grau de similaridade calculado para o nome social informado.

          **Exemplo**: `10.0`
        </ResponseField>

        <ResponseField name="motherName" type="boolean">
          Indica se o nome da mãe foi validado com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="motherNameSimilarity" type="double">
          Grau de similaridade calculado para o nome da mãe informada.

          **Exemplo**: `9.7`
        </ResponseField>

        <ResponseField name="fatherName" type="boolean">
          Indica se o nome do pai foi validado com sucesso.

          **Exemplo**: `false`
        </ResponseField>

        <ResponseField name="fatherNameSimilarity" type="double">
          Grau de similaridade calculado para o nome do pai informado.

          **Exemplo**: `2.2`
        </ResponseField>

        <ResponseField name="dateOfBirth" type="boolean">
          Indica se a data de nascimento foi validada com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="gender" type="boolean">
          Indica se o gênero foi validado com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="nationality" type="boolean">
          Indica se a nacionalidade foi validada com sucesso.

          **Exemplo**: `true`
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="biometrics" type="object">
      Resultado das validações biométricas.

      <Expandable title="propriedades">
        <ResponseField name="face" type="object">
          Resultado da validação facial.

          <Expandable title="propriedades">
            <ResponseField name="confidence" type="string">
              Nível de confiança do resultado. Valores possíveis:

              **Low**: **Alta** probabilidade de **fraude**, recomendado reprovar

              **Medium**: **Alguma** probabilidade de **fraude**, zona cinzenta que precisa de reavaliação

              **High**: **Baixa** probabilidade de **fraude**, recomendado aprovar

              **Maximum**: Probabilidade **quase nula** de **fraude**, recomendado aprovar

              **Exemplo**: `MAXIMUM`
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="fingerprints" type="array">
          Lista com o resultado individual de cada digital verificada.

          <Expandable title="propriedades">
            <ResponseField name="position" type="integer">
              Posição da digital verificada, conforme enviada na requisição.

              **Exemplo**: `1`
            </ResponseField>

            <ResponseField name="confidence" type="string">
              Nível de confiança do reconhecimento biométrico para aquela digital. Valores possíveis:

              **Low**: **Alta** probabilidade de **fraude**, recomendado reprovar

              **Medium**: **Alguma** probabilidade de **fraude**, zona cinzenta que precisa de reavaliação

              **High**: **Baixa** probabilidade de **fraude**, recomendado aprovar

              **Maximum**: Probabilidade **quase nula** de **fraude**, recomendado aprovar

              **Exemplo**: `MAXIMUM`
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="documents" type="object">
      Resultado das validações de documentos. Todos os campos retornam `true` para informação válida e `false` para negativa na validação.

      <Expandable title="propriedades">
        <ResponseField name="cpf" type="object">
          Resultado das validações do CPF.

          <Expandable title="propriedades">
            <ResponseField name="number" type="boolean">
              Indica se o número do CPF foi validado com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="status" type="boolean">
              Indica se a situação cadastral do CPF foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="registrationDate" type="boolean">
              Indica se a data de registro do CPF foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="cnh" type="object">
          Resultado das validações da CNH.

          <Expandable title="propriedades">
            <ResponseField name="registrationNumber" type="boolean">
              Indica se o número de registro da CNH foi validado com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="category" type="boolean">
              Indica se a categoria da CNH foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="status" type="boolean">
              Indica se a situação da CNH foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="foreignRegistration" type="boolean">
              Indica se o registro estrangeiro foi validado com sucesso.

              **Exemplo**: `false`
            </ResponseField>

            <ResponseField name="firstIssueDate" type="boolean">
              Indica se a data da primeira emissão foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="lastIssueDate" type="boolean">
              Indica se a data da última emissão foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="expirationDate" type="boolean">
              Indica se a data de vencimento foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="hasRestriction" type="boolean">
              Indica se a informação de restrição foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="observations" type="boolean">
              Indica se as observações da CNH foram validadas com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="qrCode" type="object">
              Resultado da validação e decodificação do QR Code da CNH.

              <Expandable title="propriedades">
                <ResponseField name="returnCode" type="string">
                  Indica o código do motivo da não realização do QR Code, quando aplicável.

                  **Exemplo**: `0`
                </ResponseField>

                <ResponseField name="name" type="boolean">
                  Indica se o nome decodificado no QR Code foi validado com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="nameSimilarity" type="double">
                  Grau de similaridade calculado para o nome decodificado.

                  **Exemplo**: `9.8`
                </ResponseField>

                <ResponseField name="decodedName" type="string">
                  Nome decodificado a partir do QR Code.

                  **Exemplo**: `JOAO DA SILVA`
                </ResponseField>

                <ResponseField name="decodedCivilName" type="string">
                  Nome civil decodificado a partir do QR Code.

                  **Exemplo**: `JOAO DA SILVA`
                </ResponseField>

                <ResponseField name="sourceDocument" type="boolean">
                  Indica se o documento de origem decodificado foi validado com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="sourceDocumentSimilarity" type="double">
                  Grau de similaridade calculado para o documento de origem.

                  **Exemplo**: `10.0`
                </ResponseField>

                <ResponseField name="decodedSourceDocument" type="string">
                  Documento de origem decodificado a partir do QR Code.

                  **Exemplo**: `CNH`
                </ResponseField>

                <ResponseField name="dateOfBirth" type="boolean">
                  Indica se a data de nascimento decodificada foi validada com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="decodedDateOfBirth" type="date">
                  Data de nascimento decodificada a partir do QR Code.

                  **Exemplo**: `1990-01-01`
                </ResponseField>

                <ResponseField name="motherName" type="boolean">
                  Indica se a filiação materna decodificada foi validada com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="motherNameSimilarity" type="double">
                  Grau de similaridade calculado para a filiação materna.

                  **Exemplo**: `9.7`
                </ResponseField>

                <ResponseField name="decodedMotherName" type="string">
                  Nome da mãe decodificado a partir do QR Code.

                  **Exemplo**: `MARIA DA SILVA`
                </ResponseField>

                <ResponseField name="fatherName" type="boolean">
                  Indica se a filiação paterna decodificada foi validada com sucesso.

                  **Exemplo**: `false`
                </ResponseField>

                <ResponseField name="fatherNameSimilarity" type="double">
                  Grau de similaridade calculado para a filiação paterna.

                  **Exemplo**: `2.2`
                </ResponseField>

                <ResponseField name="decodedFatherName" type="string">
                  Nome do pai decodificado a partir do QR Code.

                  **Exemplo**: `JOSE DA SILVA`
                </ResponseField>

                <ResponseField name="decodedPermission" type="string">
                  Permissão decodificada a partir do QR Code.

                  **Exemplo**: `ACC`
                </ResponseField>

                <ResponseField name="decodedAcc" type="string">
                  Informação de ACC decodificada a partir do QR Code.

                  **Exemplo**: `N`
                </ResponseField>

                <ResponseField name="category" type="boolean">
                  Indica se a categoria decodificada foi validada com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="categorySimilarity" type="double">
                  Grau de similaridade calculado para a categoria.

                  **Exemplo**: `10.0`
                </ResponseField>

                <ResponseField name="decodedCategory" type="string">
                  Categoria decodificada a partir do QR Code.

                  **Exemplo**: `B`
                </ResponseField>

                <ResponseField name="registrationNumber" type="boolean">
                  Indica se o número de registro decodificado foi validado com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="decodedRegistrationNumber" type="string">
                  Número de registro decodificado a partir do QR Code.

                  **Exemplo**: `12345678900`
                </ResponseField>

                <ResponseField name="expirationDate" type="boolean">
                  Indica se a data de validade decodificada foi validada com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="decodedExpirationDate" type="date">
                  Data de validade decodificada a partir do QR Code.

                  **Exemplo**: `2030-01-15`
                </ResponseField>

                <ResponseField name="firstLicenseDate" type="boolean">
                  Indica se a data da primeira habilitação decodificada foi validada com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="decodedFirstLicenseDate" type="date">
                  Data da primeira habilitação decodificada a partir do QR Code.

                  **Exemplo**: `2010-01-15`
                </ResponseField>

                <ResponseField name="observations" type="boolean">
                  Indica se as observações decodificadas foram validadas com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="observationsSimilarity" type="double">
                  Grau de similaridade calculado para as observações.

                  **Exemplo**: `9.1`
                </ResponseField>

                <ResponseField name="decodedObservations" type="string">
                  Observações decodificadas a partir do QR Code.

                  **Exemplo**: `EAR;A`
                </ResponseField>

                <ResponseField name="decodedIssueLocation" type="string">
                  Local de emissão decodificado a partir do QR Code.

                  **Exemplo**: `SAO PAULO`
                </ResponseField>

                <ResponseField name="decodedIssueState" type="string">
                  UF de emissão decodificada a partir do QR Code.

                  **Exemplo**: `SP`
                </ResponseField>

                <ResponseField name="lastIssueDate" type="boolean">
                  Indica se a data da última emissão decodificada foi validada com sucesso.

                  **Exemplo**: `true`
                </ResponseField>

                <ResponseField name="decodedLastIssueDate" type="date">
                  Data da última emissão decodificada a partir do QR Code.

                  **Exemplo**: `2020-01-15`
                </ResponseField>

                <ResponseField name="decodedValidationNumber" type="string">
                  Número de validação decodificado a partir do QR Code.

                  **Exemplo**: `123456789`
                </ResponseField>

                <ResponseField name="decodedRenachNumber" type="string">
                  Número RENACH decodificado a partir do QR Code.

                  **Exemplo**: `987654321`
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="rg" type="object">
          Resultado das validações do RG.

          <Expandable title="propriedades">
            <ResponseField name="number" type="boolean">
              Indica se o número do RG foi validado com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="issuer" type="boolean">
              Indica se o órgão emissor do RG foi validado com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="issuerState" type="boolean">
              Indica se a UF emissora do RG foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="ctps" type="object">
          Resultado das validações da CTPS.

          <Expandable title="propriedades">
            <ResponseField name="number" type="boolean">
              Indica se o número da CTPS foi validado com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="issuer" type="boolean">
              Indica se o órgão emissor da CTPS foi validado com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="issuerState" type="boolean">
              Indica se a UF emissora da CTPS foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="passport" type="object">
          Resultado das validações do passaporte.

          <Expandable title="propriedades">
            <ResponseField name="number" type="boolean">
              Indica se o número do passaporte foi validado com sucesso.

              **Exemplo**: `false`
            </ResponseField>

            <ResponseField name="issuer" type="boolean">
              Indica se o órgão emissor do passaporte foi validado com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="issuerState" type="boolean">
              Indica se a UF emissora do passaporte foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="militaryService" type="object">
          Resultado das validações do documento militar.

          <Expandable title="propriedades">
            <ResponseField name="number" type="boolean">
              Indica se o número do documento militar foi validado com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="issuer" type="boolean">
              Indica se o órgão emissor do documento militar foi validado com sucesso.

              **Exemplo**: `true`
            </ResponseField>

            <ResponseField name="issuerState" type="boolean">
              Indica se a UF emissora do documento militar foi validada com sucesso.

              **Exemplo**: `true`
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="address" type="object">
      Resultado das validações de endereço.

      <Expandable title="propriedades">
        <ResponseField name="street" type="boolean">
          Indica se o logradouro foi validado com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="streetSimilarity" type="double">
          Grau de similaridade calculado para o logradouro informado.

          **Exemplo**: `0.94`
        </ResponseField>

        <ResponseField name="number" type="boolean">
          Indica se o número do endereço foi validado com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="numberSimilarity" type="double">
          Grau de similaridade calculado para o número informado.

          **Exemplo**: `10.0`
        </ResponseField>

        <ResponseField name="complement" type="boolean">
          Indica se o complemento foi validado com sucesso.

          **Exemplo**: `false`
        </ResponseField>

        <ResponseField name="complementSimilarity" type="double">
          Grau de similaridade calculado para o complemento informado.

          **Exemplo**: `1.4`
        </ResponseField>

        <ResponseField name="neighborhood" type="boolean">
          Indica se o bairro foi validado com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="neighborhoodSimilarity" type="double">
          Grau de similaridade calculado para o bairro informado.

          **Exemplo**: `9.6`
        </ResponseField>

        <ResponseField name="postalCode" type="boolean">
          Indica se o CEP foi validado com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="city" type="boolean">
          Indica se a cidade foi validada com sucesso.

          **Exemplo**: `true`
        </ResponseField>

        <ResponseField name="citySimilarity" type="double">
          Grau de similaridade calculado para a cidade informada.

          **Exemplo**: `9.9`
        </ResponseField>

        <ResponseField name="state" type="boolean">
          Indica se o estado foi validado com sucesso.

          **Exemplo**: `true`
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="metadata" type="object">
  Metadados da requisição

  <Expandable title="propriedades">
    <ResponseField name="processingTime" type="integer">
      Tempo total de processamento em milisegundos.

      **Exemplo**: `2345`
    </ResponseField>

    <ResponseField name="timestamp" type="datetime">
      Data e hora da transação.

      **Exemplo**: `2026-04-20T19:04:17.412Z`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 theme={"theme":"catppuccin-latte"}
  {
    "scanId": "123e4567-e89b-12d3-a456-426614174000",
    "identity": {
  	  "type": "cpf",
  	  "value": true
    },
    "attributes": {
      "biographic": {
        "name": true,
        "nameSimilarity": 9.8,
        "socialName": true,
        "socialNameSimilarity": 9.9,
        "motherName": true,
        "motherNameSimilarity": 10.0,
        "fatherName": false,
        "fatherNameSimilarity": 1.2,
        "dateOfBirth": true,
        "gender": true,
        "nationality": true
      },
      "biometrics": {
        "face": {
          "confidence": "HIGH",
        },
        "fingerprints": [
          {
            "position": 1,
            "confidence": "MAXIMUM",
          },
          {
            "position": 2,
            "confidence": "HIGH",
          }
        ]
      },
      "documents": {
        "cpf": {
          "number": true,
          "status": true,
          "registrationDate": true
        },
        "cnh": {
          "registrationNumber": true,
          "category": true,
          "status": true,
          "foreignRegistration": false,
          "firstIssueDate": true,
          "lastIssueDate": true,
          "expirationDate": true,
          "hasRestriction": true,
          "observations": true,
          "qrCode": {
            "returnCode": "0",
            "name": true,
            "nameSimilarity": 9.9,
            "decodedName": "JOAO DA SILVA",
            "decodedCivilName": "JOAO DA SILVA",
            "sourceDocument": true,
            "sourceDocumentSimilarity": 10.0,
            "decodedSourceDocument": "CNH",
            "dateOfBirth": true,
            "decodedDateOfBirth": "1990-01-01",
            "motherName": true,
            "motherNameSimilarity": 9.7,
            "decodedMotherName": "MARIA DA SILVA",
            "fatherName": false,
            "fatherNameSimilarity": 2.2,
            "decodedFatherName": "JOSE DA SILVA",
            "decodedPermission": "ACC",
            "decodedAcc": "N",
            "category": true,
            "categorySimilarity": 10.0,
            "decodedCategory": "B",
            "registrationNumber": true,
            "decodedRegistrationNumber": "12345678900",
            "expirationDate": true,
            "decodedExpirationDate": "2030-01-15",
            "firstLicenseDate": true,
            "decodedFirstLicenseDate": "2010-01-15",
            "observations": true,
            "observationsSimilarity": 9.1,
            "decodedObservations": "EAR;A",
            "decodedIssueLocation": "SAO PAULO",
            "decodedIssueState": "SP",
            "lastIssueDate": true,
            "decodedLastIssueDate": "2020-01-15",
            "decodedValidationNumber": "123456789",
            "decodedRenachNumber": "987654321"
          }
        },
        "rg": {
          "number": true,
          "issuer": true,
          "issuerState": true
        },
        "ctps": {
          "number": true,
          "issuer": true,
          "issuerState": true
        },
        "passport": {
          "number": false,
          "issuer": true,
          "issuerState": true
        },
        "militaryService": {
          "number": true,
          "issuer": true,
          "issuerState": true
        }
      },
      "address": {
        "street": true,
        "streetSimilarity": 9.4,
        "number": true,
        "numberSimilarity": 10.0,
        "complement": false,
        "complementSimilarity": 2.1,
        "neighborhood": true,
        "neighborhoodSimilarity": 9.9,
        "postalCode": true,
        "city": true,
        "citySimilarity": 10.0,
        "state": true,
      }
    },
    "metadata": {
      "processingTime": 2345,
      "timestamp": "2026-04-20T19:04:17.412Z"
    }
  }
  ```

  ```json 400 theme={"theme":"catppuccin-latte"}
  {
      "success": false,
      "error": {
          "issues": [
              {
                  "code": "invalid_type",
                  "expected": "string",
                  "received": "undefined",
                  "path": [
                      "cpf"
                  ],
                  "message": "Required"
              }
          ],
          "name": "ZodError"
      }
  }
  ```

  ```json 500 theme={"theme":"catppuccin-latte"}
  {
    "error": "INTERNAL_SERVER_ERROR",
    "message": "Unexpected error while processing scan request",
    "requestId": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2026-04-20T19:04:17.412Z"
  }
  ```
</ResponseExample>