> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# DVS Austrália: API de verificação de documentos de viagem

> Consulta à base de dados oficial da Austrália para documentos de viagem, via Didit. Pagamento por chamada a partir de $0.75, sem contratos.

Verifica os dados introduzidos no Document Verification Service (DVS). A Didit disponibiliza este serviço através de `POST /v3/database-validation/`, para que possa verificar os dados submetidos na fonte oficial e receber resultados de correspondência normalizados. Formato de entrada: `passport_issue_country` recebe o código de país ISO 3166-1 alfa-3.

## Cobertura

* **Cobertura:** 100%\*
* **País:** Austrália
* **ID do serviço:** `aus_travel_document`
* **Domínio de dados:** Documento
* **Categoria:** Passaporte

## Campos de entrada

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `first_name` | Sim | `John` |
| `last_name` | Sim | `Doe` |
| `passport_number` | Sim | `SAMPLE-PASS-12345` |
| `passport_issue_country` | Sim | `USA` |
| `vendor_data` | Não | `user-1234` |

* **Campos obrigatórios:** `first_name`, `last_name`, `passport_number`, `passport_issue_country`
* **Campos opcionais:** `vendor_data`
* **Consentimento:** obrigatório
* **Disponibilidade no fluxo:** disponível no fluxo
* **Cobertura:** 100%\*
* **Preço:** \$0.75 por consulta bem-sucedida

## Parâmetros do corpo

**issuing\_state** `string` *required* (default: AUS)

Código de país ISO 3166-1 alfa-3 para este serviço de base de dados.

Exemplo: `AUS`

**services** `string` *required* (default: aus\_travel\_document)

Matriz que contém este ID de serviço. Fixar o serviço restringe o pedido a esta base de dados específica.

Exemplo: `aus_travel_document`

**consent** `boolean` *required* (default: true)

Consentimento explícito do utilizador final para este serviço.

Exemplo: `true`

**first\_name** `string` *required* (default: John)

Nome próprio a validar.

Exemplo: `John`

**last\_name** `string` *required* (default: Doe)

Apelido a validar.

Exemplo: `Doe`

**passport\_number** `string` *required* (default: SAMPLE-PASS-12345)

Número do passaporte.

Exemplo: `SAMPLE-PASS-12345`

**passport\_issue\_country** `string` *required* (default: USA)

Código de país ISO 3166-1 alfa-3 do país que emitiu o passaporte.

Exemplo: `USA`

**vendor\_data** `string` (default: user-1234)

A sua referência estável de utilizador para esta pessoa, como o ID interno do utilizador. A Didit usa-a para associar verificações independentes ao mesmo utilizador final e reduzir o ruído na deteção de duplicados.

Exemplo: `user-1234`

## Regras de entrada e notas de validação

* Código de país ISO 3166-1 alfa-3
* `passport_issue_country` deve usar letras maiúsculas.
* `passport_issue_country` deve corresponder a `[A-Za-z]{3}`.

## Como fazer a chamada

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=AUS" \
  -F "services=aus_travel_document" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "passport_number=SAMPLE-PASS-12345" \
  -F "passport_issue_country=USA"
```

```python Python theme={null}
from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="AUS",
    services=["aus_travel_document"],
    consent=True,
    first_name="John",
    last_name="Doe",
    passport_number="SAMPLE-PASS-12345",
    passport_issue_country="USA",
    vendor_data="user-1234",
)
print(result)
```

```javascript Node.js theme={null}
import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "AUS",
  services: ["aus_travel_document"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  passport_number: "SAMPLE-PASS-12345",
  passport_issue_country: "USA",
  vendor_data: "user-1234",
});
console.log(result);
```

```go Go theme={null}
ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{
	IssuingState:         "AUS",
	Services:             didit.Some([]string{"aus_travel_document"}),
	Consent:              didit.Bool(true),
	FirstName:            didit.String("John"),
	LastName:             didit.String("Doe"),
	PassportNumber:       didit.String("SAMPLE-PASS-12345"),
	PassportIssueCountry: didit.String("USA"),
	VendorData:           didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.util.List;
import me.didit.Didit;
import me.didit.types.DatabaseValidationValidateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()
        .issuingState("AUS")
        .services(List.of("aus_travel_document"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .passportNumber("SAMPLE-PASS-12345")
        .passportIssueCountry("USA")
        .vendorData("user-1234")
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'AUS',
    'services' => ['aus_travel_document'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'passport_number' => 'SAMPLE-PASS-12345',
    'passport_issue_country' => 'USA',
    'vendor_data' => 'user-1234',
]);
print_r($result->toArray());
```

```ruby Ruby theme={null}
require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.database_validation.validate(
  issuing_state: "AUS",
  services: ["aus_travel_document"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  passport_number: "SAMPLE-PASS-12345",
  passport_issue_country: "USA",
  vendor_data: "user-1234"
)
puts result.to_h
```

```csharp .NET theme={null}
using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams
{
    IssuingState = "AUS",
    Services = new string[] { "aus_travel_document" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    PassportNumber = "SAMPLE-PASS-12345",
    PassportIssueCountry = "USA",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Todas as chamadas bem-sucedidas devolvem HTTP `200`. O campo **`outcome_code`** indica o que aconteceu de facto, distinguindo, por exemplo, uma incompatibilidade biométrica real (`BIOMETRIC_NO_MATCH`) de uma selfie que não pôde ser lida (`BIOMETRIC_IMAGE_UNUSABLE`). O `status` apresentado é o estado predefinido da funcionalidade; as suas [ações configuradas para correspondência parcial / sem correspondência](https://docs.didit.me/pt/core-technology/database-validation/database-validation-warnings.md) podem substituí-lo.

**`MATCH`**: o registo confirmou a identidade e todos os campos verificados correspondem.

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "AUS",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "aus_travel_document",
      "service_name": "Australia - DVS - Travel Document",
      "source_data": {
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**: o número de identificação foi encontrado, mas um ou mais campos pessoais (normalmente o nome ou a data de nascimento) não correspondem totalmente.

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "AUS",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "aus_travel_document",
      "service_name": "Australia - DVS - Travel Document",
      "source_data": {
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "full_name": "no_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: o registo não devolveu qualquer correspondência para os dados submetidos.

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "AUS",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "aus_travel_document",
      "service_name": "Australia - DVS - Travel Document",
      "source_data": {
        "full_name": "NO_MATCH",
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "full_name": "no_match",
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Dados devolvidos

Os campos exatos apresentados em `source_data` dependem do que o registo devolve. O exemplo gerado para `aus_travel_document` documenta atualmente esta estrutura normalizada:

* `first_name`
* `identification_number`
* `last_name`

## Preços e SLAs

As consultas Austrália - DVS - Documento de viagem só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.75 USD.
* **Faturação:** por consulta bem-sucedida. Não é cobrado quando o registo está inacessível, quando faltam campos obrigatórios ou quando o pedido é rejeitado antes de chegar à fonte.
* **Latência:** p95 típico inferior a 2 s.
* **Disponibilidade:** 99.9% por trimestre do lado da Didit; a disponibilidade das fontes a jusante varia consoante o país e o conjunto de dados.

## Continue a ler

* [Visão geral da Validação de base de dados na Austrália](https://docs.didit.me/api-reference/database-validation/australia.md)
* [Visão geral da Validação de base de dados](https://docs.didit.me/pt/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/pt/core-technology/database-validation/database-validation-outcome-codes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.