> ## 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.

# API de Certidão de Casamento da Austrália – DVS

> Certidão de casamento da Austrália (DVS): consulta à base oficial via Didit. A partir de $0.75 por chamada, sem contratos nem mínimos.

Verifica os dados de entrada no Document Verification Service (DVS). A Didit disponibiliza esse serviço por meio de `POST /v3/database-validation/` para que você possa verificar os dados enviados na fonte oficial e receber resultados de correspondência normalizados.

## Cobertura

* **Cobertura:** 100%\*
* **País:** Austrália
* **ID do serviço:** `aus_marriage_certificate`
* **Domínio de dados:** Identidade
* **Categoria:** CivilRegistry

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `first_name` | Sim | `John` |
| `last_name` | Sim | `Doe` |
| `first_partner_name` | Sim | `Jamie` |
| `last_partner_name` | Sim | `Example` |
| `marriage_certificate_number` | Sim | `SAMPLE-MARRIAGE-12345` |
| `birth_registration_number` | Sim | `SAMPLE-BIRTH-12345` |
| `birth_registration_state` | Sim | `Sample State` |
| `birth_registration_date` | Sim | `1990-01-01` |
| `vendor_data` | Não | `user-1234` |

* **Entradas obrigatórias:** `first_name`, `last_name`, `first_partner_name`, `last_partner_name`, `marriage_certificate_number`, `birth_registration_number`, `birth_registration_state`, `birth_registration_date`
* **Entradas opcionais:** `vendor_data`
* **Consentimento:** Obrigatório
* **Disponibilidade no fluxo de verificação (workflow):** Disponível no fluxo com mapeamento de campos
* **Cobertura:** 100%\*
* **Preço:** \$0.75 por consulta bem-sucedida

Em um fluxo, `first_partner_name`, `last_partner_name`, `birth_registration_state` e `birth_registration_date` não constam em um documento de identidade, então nenhuma etapa os gera por conta própria. Colete esses dados a partir de uma resposta de Questionário, de um campo de extração do Document AI ou de um valor que você envia ao criar a sessão, e mapeie cada um deles na etapa de Validação de banco de dados. Enquanto eles não forem mapeados, o editor de fluxos mostra este serviço como desativado e indica a entrada ausente; em tempo de execução, uma entrada ausente faz com que a verificação seja ignorada antes de qualquer consulta, então você nunca é cobrado por uma consulta a um banco de dados que não pôde ser realizada.

## Parâmetros do corpo

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

Código de país ISO 3166-1 alpha-3 deste serviço de banco de dados.

Exemplo: `AUS`

**services** `string` *required* (default: aus\_marriage\_certificate)

Array que contém o ID deste serviço. A fixação do serviço mantém a requisição restrita a este banco de dados específico.

Exemplo: `aus_marriage_certificate`

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

Consentimento explícito do usuário final para este serviço.

Exemplo: `true`

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

Nome a ser validado.

Exemplo: `John`

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

Sobrenome a ser validado.

Exemplo: `Doe`

**first\_partner\_name** `string` *required* (default: Jamie)

Valor de `first_partner_name` exigido por este serviço de banco de dados.

Exemplo: `Jamie`

**last\_partner\_name** `string` *required* (default: Example)

Valor de `last_partner_name` exigido por este serviço de banco de dados.

Exemplo: `Example`

**marriage\_certificate\_number** `string` *required* (default: SAMPLE-MARRIAGE-12345)

Valor de `marriage_certificate_number` exigido por este serviço de banco de dados.

Exemplo: `SAMPLE-MARRIAGE-12345`

**birth\_registration\_number** `string` *required* (default: SAMPLE-BIRTH-12345)

Valor de `birth_registration_number` exigido por este serviço de banco de dados.

Exemplo: `SAMPLE-BIRTH-12345`

**birth\_registration\_state** `string` *required* (default: Sample State)

Valor de `birth_registration_state` exigido por este serviço de banco de dados.

Exemplo: `Sample State`

**birth\_registration\_date** `string` *required* (default: 1990-01-01)

Valor de `birth_registration_date` exigido por este serviço de banco de dados.

Exemplo: `1990-01-01`

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

Sua referência estável de usuário para esta pessoa, como o ID interno do usuário. A Didit a usa para vincular verificações avulsas ao mesmo usuário final e reduzir ruído na detecção de duplicatas.

Exemplo: `user-1234`

## Regras de entrada e observações de validação

* Envie os campos listados acima exatamente como foram capturados do usuário ou do documento.
* A Didit valida os campos obrigatórios antes de consultar o banco de dados. Requisições rejeitadas antes da consulta à fonte de dados não são cobradas.

## 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_marriage_certificate" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "first_partner_name=Jamie" \
  -F "last_partner_name=Example" \
  -F "marriage_certificate_number=SAMPLE-MARRIAGE-12345" \
  -F "birth_registration_number=SAMPLE-BIRTH-12345" \
  -F "birth_registration_state=Sample State" \
  -F "birth_registration_date=1990-01-01"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="AUS",
    services=["aus_marriage_certificate"],
    consent=True,
    first_name="John",
    last_name="Doe",
    birth_registration_number="SAMPLE-BIRTH-12345",
    birth_registration_date="1990-01-01",
    birth_registration_state="Sample State",
    marriage_certificate_number="SAMPLE-MARRIAGE-12345",
    first_partner_name="Jamie",
    last_partner_name="Example",
    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_marriage_certificate"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  birth_registration_number: "SAMPLE-BIRTH-12345",
  birth_registration_date: "1990-01-01",
  birth_registration_state: "Sample State",
  marriage_certificate_number: "SAMPLE-MARRIAGE-12345",
  first_partner_name: "Jamie",
  last_partner_name: "Example",
  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_marriage_certificate"}),
	Consent:                   didit.Bool(true),
	FirstName:                 didit.String("John"),
	LastName:                  didit.String("Doe"),
	BirthRegistrationNumber:   didit.String("SAMPLE-BIRTH-12345"),
	BirthRegistrationDate:     didit.String("1990-01-01"),
	BirthRegistrationState:    didit.String("Sample State"),
	MarriageCertificateNumber: didit.String("SAMPLE-MARRIAGE-12345"),
	FirstPartnerName:          didit.String("Jamie"),
	LastPartnerName:           didit.String("Example"),
	VendorData:                didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.time.LocalDate;
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_marriage_certificate"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .birthRegistrationNumber("SAMPLE-BIRTH-12345")
        .birthRegistrationDate(LocalDate.parse("1990-01-01"))
        .birthRegistrationState("Sample State")
        .marriageCertificateNumber("SAMPLE-MARRIAGE-12345")
        .firstPartnerName("Jamie")
        .lastPartnerName("Example")
        .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_marriage_certificate'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'birth_registration_number' => 'SAMPLE-BIRTH-12345',
    'birth_registration_date' => '1990-01-01',
    'birth_registration_state' => 'Sample State',
    'marriage_certificate_number' => 'SAMPLE-MARRIAGE-12345',
    'first_partner_name' => 'Jamie',
    'last_partner_name' => 'Example',
    '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_marriage_certificate"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  birth_registration_number: "SAMPLE-BIRTH-12345",
  birth_registration_date: "1990-01-01",
  birth_registration_state: "Sample State",
  marriage_certificate_number: "SAMPLE-MARRIAGE-12345",
  first_partner_name: "Jamie",
  last_partner_name: "Example",
  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_marriage_certificate" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    BirthRegistrationNumber = "SAMPLE-BIRTH-12345",
    BirthRegistrationDate = "1990-01-01",
    BirthRegistrationState = "Sample State",
    MarriageCertificateNumber = "SAMPLE-MARRIAGE-12345",
    FirstPartnerName = "Jamie",
    LastPartnerName = "Example",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Toda chamada bem-sucedida retorna HTTP `200`. O campo **`outcome_code`** informa o que de fato aconteceu, distinguindo, por exemplo, uma divergência biométrica real (`BIOMETRIC_NO_MATCH`) de uma selfie que não pôde ser lida (`BIOMETRIC_IMAGE_UNUSABLE`). O `status` exibido é o status padrão do recurso; as [ações de Partial Match / No Match](https://docs.didit.me/pt-br/core-technology/database-validation/database-validation-warnings.md) que você configurou podem substituí-lo.

**`MATCH`**: o registro confirmou a identidade e todos os campos verificados corresponderam.

```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_marriage_certificate",
      "service_name": "Australia - DVS – Marriage Certificate",
      "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 (geralmente o nome ou a data de nascimento) não corresponderam 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_marriage_certificate",
      "service_name": "Australia - DVS – Marriage Certificate",
      "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 registro não retornou nenhuma correspondência para os dados enviados.

```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_marriage_certificate",
      "service_name": "Australia - DVS – Marriage Certificate",
      "source_data": {
        "full_name": "NO_MATCH",
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "full_name": "no_match",
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Dados retornados

Os campos exatos expostos em `source_data` dependem dos dados retornados pelo registro. O exemplo gerado para `aus_marriage_certificate` documenta atualmente este formato normalizado:

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

## Preços e SLAs

As consultas de Australia - DVS – Marriage Certificate são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.75 USD.
* **Faturamento:** por consulta bem-sucedida. Você não é cobrado quando o registro não está acessível, quando faltam campos obrigatórios ou quando a requisição é rejeitada antes de chegar à fonte.
* **Latência:** p95 típico \< 2 s.
* **Disponibilidade:** 99.9% por trimestre do lado da Didit; a disponibilidade da fonte externa varia por país e conjunto de dados.

## Continue lendo

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


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