> ## 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 certificado de ciudadanía de Australia (DVS)

> Verifica el certificado de ciudadanía australiano (DVS) en la base de datos oficial con Didit. Desde $0.75 por consulta, sin contratos ni mínimos.

Verifica los datos de entrada con el Document Verification Service (DVS). Didit ofrece este servicio a través de `POST /v3/database-validation/` para que puedas verificar los datos enviados con la fuente oficial y recibir resultados de coincidencia normalizados.

## Cobertura

* **Cobertura:** 100%\*
* **País:** Australia
* **ID del servicio:** `aus_citizenship_certificate`
* **Ámbito de datos:** Identidad
* **Categoría:** Ciudadanía

## Datos de entrada

| Campo | Obligatorio | Ejemplo |
| - | -: | - |
| `first_name` | Sí | `John` |
| `last_name` | Sí | `Doe` |
| `date_of_birth` | Sí | `1990-01-01` |
| `citizenship_certificate_number` | Sí | `SAMPLE-CERT-12345` |
| `middle_name` | No | `Demo` |
| `vendor_data` | No | `user-1234` |

* **Datos de entrada obligatorios:** `first_name`, `last_name`, `date_of_birth`, `citizenship_certificate_number`
* **Datos de entrada opcionales:** `middle_name`, `vendor_data`
* **Consentimiento:** Obligatorio
* **Disponibilidad en flujos:** Disponible en el flujo de verificación (workflow) con mapeo de campos
* **Cobertura:** 100%\*
* **Precio:** \$0.75 por consulta exitosa

En un flujo, `citizenship_certificate_number` no figura impreso en ningún documento de identidad, así que ningún paso lo genera por sí solo. Recógelo de una respuesta de un cuestionario, de un campo de extracción de Document AI o de un valor que envíes al crear la sesión, y mapéalo en el paso de Validación de base de datos. Mientras no esté mapeado, el editor de flujos muestra este servicio desactivado e indica el dato de entrada que falta; durante la ejecución, si falta un dato de entrada, la comprobación se omite antes de realizar cualquier consulta, por lo que nunca se te factura por una base de datos que no se pudo consultar.

## Parámetros del cuerpo

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

Código de país ISO 3166-1 alfa-3 para este servicio de base de datos.

Ejemplo: `AUS`

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

Array que contiene este ID de servicio. Fijar el servicio limita la solicitud a esta base de datos concreta.

Ejemplo: `aus_citizenship_certificate`

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

Consentimiento explícito del usuario final para este servicio.

Ejemplo: `true`

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

Nombre de pila que se debe validar.

Ejemplo: `John`

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

Apellido que se debe validar.

Ejemplo: `Doe`

**date\_of\_birth** `string` *required* (default: 1990-01-01)

Fecha de nacimiento en formato `YYYY-MM-DD`.

Ejemplo: `1990-01-01`

**citizenship\_certificate\_number** `string` *required* (default: SAMPLE-CERT-12345)

Valor de `citizenship_certificate_number` que exige este servicio de base de datos.

Ejemplo: `SAMPLE-CERT-12345`

**middle\_name** `string`

Segundo nombre, cuando esté disponible.

Ejemplo: `Demo`

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

Tu referencia estable de usuario para esta persona, como tu ID de usuario interno. Didit la usa para vincular las comprobaciones independientes al mismo usuario final y reducir el ruido en la detección de duplicados.

Ejemplo: `user-1234`

## Reglas de entrada y notas de validación

* Envía los campos indicados arriba exactamente como se capturaron del usuario o del documento.
* Didit valida los campos obligatorios antes de consultar la base de datos. Las solicitudes rechazadas antes de la consulta a la fuente no se cobran.

## Cómo invocarlo

```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_citizenship_certificate" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01" \
  -F "citizenship_certificate_number=SAMPLE-CERT-12345"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="AUS",
    services=["aus_citizenship_certificate"],
    consent=True,
    first_name="John",
    last_name="Doe",
    date_of_birth="1990-01-01",
    citizenship_certificate_number="SAMPLE-CERT-12345",
    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_citizenship_certificate"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  citizenship_certificate_number: "SAMPLE-CERT-12345",
  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_citizenship_certificate"}),
	Consent:                      didit.Bool(true),
	FirstName:                    didit.String("John"),
	LastName:                     didit.String("Doe"),
	DateOfBirth:                  didit.String("1990-01-01"),
	CitizenshipCertificateNumber: didit.String("SAMPLE-CERT-12345"),
	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_citizenship_certificate"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .citizenshipCertificateNumber("SAMPLE-CERT-12345")
        .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_citizenship_certificate'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'date_of_birth' => '1990-01-01',
    'citizenship_certificate_number' => 'SAMPLE-CERT-12345',
    '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_citizenship_certificate"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  date_of_birth: "1990-01-01",
  citizenship_certificate_number: "SAMPLE-CERT-12345",
  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_citizenship_certificate" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    DateOfBirth = "1990-01-01",
    CitizenshipCertificateNumber = "SAMPLE-CERT-12345",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Toda llamada exitosa devuelve HTTP `200`. El campo **`outcome_code`** te indica qué ocurrió realmente; distingue, por ejemplo, una falta de coincidencia biométrica real (`BIOMETRIC_NO_MATCH`) de una selfie que no se pudo leer (`BIOMETRIC_IMAGE_UNUSABLE`). El `status` mostrado es el estado predeterminado de la función; las [acciones para Partial Match / No Match](https://docs.didit.me/es/core-technology/database-validation/database-validation-warnings.md) que hayas configurado pueden sobrescribirlo.

**`MATCH`**: el registro confirmó la identidad y todos los campos comprobados coincidieron.

```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_citizenship_certificate",
      "service_name": "Australia - DVS – Citizenship Certificate",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "middle_name": "Demo"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**: se encontró el número de identificación, pero uno o más campos personales (normalmente el nombre o la fecha de nacimiento) no coincidieron por completo.

```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_citizenship_certificate",
      "service_name": "Australia - DVS – Citizenship Certificate",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "middle_name": "Demo"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "no_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: el registro no devolvió ninguna coincidencia para los datos 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_citizenship_certificate",
      "service_name": "Australia - DVS – Citizenship Certificate",
      "source_data": {
        "date_of_birth": "NO_MATCH",
        "full_name": "NO_MATCH",
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "date_of_birth": "no_match",
        "full_name": "no_match",
        "identification_number": "no_match"
      }
    }
  ]
}
```

## Datos devueltos

Los campos exactos que aparecen en `source_data` dependen de lo que devuelva el registro. El ejemplo generado para `aus_citizenship_certificate` documenta actualmente esta estructura normalizada:

* `date_of_birth`
* `first_name`
* `identification_number`
* `last_name`
* `middle_name`

## Precios y SLA

Las consultas de Australia - DVS – Certificado de ciudadanía solo se facturan cuando Didit recibe un resultado concluyente de la fuente de validación.

* **Precio por llamada:** \$0.75 USD.
* **Facturación:** por consulta exitosa. No se te cobra cuando el registro no está accesible, cuando faltan campos obligatorios o cuando la solicitud se rechaza antes de llegar a la fuente.
* **Latencia:** p95 habitual \< 2 s.
* **Disponibilidad:** 99.9% por trimestre por parte de Didit; la disponibilidad de la fuente externa varía según el país y el conjunto de datos.

## Continúa leyendo

* [Validación de base de datos en Australia: visión general](https://docs.didit.me/api-reference/database-validation/australia.md)
* [Validación de base de datos: visión general](https://docs.didit.me/es/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/es/core-technology/database-validation/database-validation-outcome-codes.md)


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