> ## 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 - Migración Colombia

> 通过 Didit 查询哥伦比亚权威数据库（Migración Colombia）中的外籍人士身份状态。按次计费，每次调用低至 $1.20，无合同、无最低消费。

验证外籍人士在哥伦比亚 Migración Colombia 政府记录（cédula de extranjería）中的移民状态和身份信息。Didit 通过 `POST /v3/database-validation/` 提供此服务，帮助您将提交的数据与权威来源进行核对，并获取标准化的匹配结果。输入格式：`personal_number` 接受哥伦比亚 Cédula（6-10 位数字）。

## 覆盖范围

* **覆盖范围：** —
* **国家/地区：** 哥伦比亚
* **服务 ID：** `col_migracion`
* **数据领域：** 身份
* **类别：** ResidencePermit

## 输入

| 字段 | 必填 | 示例 |
| - | -: | - |
| `personal_number` | 是 | `111111` |
| `date_of_birth` | 是 | `1990-01-01` |
| `nationality` | 是 | `MEX` |
| `first_name` | 否 | `John` |
| `last_name` | 否 | `Doe` |
| `vendor_data` | 否 | `user-1234` |

* **必填输入：** `personal_number`、`date_of_birth`、`nationality`
* **可选输入：** `first_name`、`last_name`、`vendor_data`
* **同意：** 不需要
* **工作流可用性：** 可在工作流中使用
* **覆盖范围：** —
* **价格：** 每次成功查询 \$1.20

## 请求体参数

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

该数据库服务的 ISO 3166-1 alpha-3 国家代码。

示例：`COL`

**services** `string` *required* (default: col\_migracion)

包含此服务 ID 的数组。固定服务 ID 可将请求限定在此特定数据库中。

示例：`col_migracion`

**personal\_number** `string` *required* (default: 111111)

特定国家的个人身份编号。

示例：`111111`

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

出生日期，格式为 `YYYY-MM-DD`。

示例：`1990-01-01`

**nationality** `string` *required* (default: MEX)

此数据库服务所需的 `nationality` 值。

示例：`MEX`

**first\_name** `string`

需要验证的名字。

示例：`John`

**last\_name** `string`

需要验证的姓氏。

示例：`Doe`

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

您为此人分配的稳定用户引用，例如您内部的用户 ID。Didit 利用它将独立检查关联到同一终端用户，并减少重复检测的干扰。

示例：`user-1234`

## 输入规则与验证说明

* 哥伦比亚 Cédula（6-10 位数字）
* `personal_number` 只能包含数字；发送请求前请去除空格、连字符和标点符号。
* `personal_number` 的长度必须为 6-10 个字符。

## 调用方式

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=COL" \
  -F "services=col_migracion" \
  -F "vendor_data=user-1234" \
  -F "personal_number=111111" \
  -F "date_of_birth=1990-01-01" \
  -F "nationality=MEX"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="COL",
    services=["col_migracion"],
    date_of_birth="1990-01-01",
    personal_number="111111",
    nationality="MEX",
    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: "COL",
  services: ["col_migracion"],
  date_of_birth: "1990-01-01",
  personal_number: "111111",
  nationality: "MEX",
  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:   "COL",
	Services:       didit.Some([]string{"col_migracion"}),
	DateOfBirth:    didit.String("1990-01-01"),
	PersonalNumber: didit.String("111111"),
	Nationality:    didit.String("MEX"),
	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("COL")
        .services(List.of("col_migracion"))
        .dateOfBirth(LocalDate.parse("1990-01-01"))
        .personalNumber("111111")
        .nationality("MEX")
        .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' => 'COL',
    'services' => ['col_migracion'],
    'date_of_birth' => '1990-01-01',
    'personal_number' => '111111',
    'nationality' => 'MEX',
    '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: "COL",
  services: ["col_migracion"],
  date_of_birth: "1990-01-01",
  personal_number: "111111",
  nationality: "MEX",
  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 = "COL",
    Services = new string[] { "col_migracion" },
    DateOfBirth = "1990-01-01",
    PersonalNumber = "111111",
    Nationality = "MEX",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

每次成功调用都会返回 HTTP `200`。**`outcome_code`** 字段说明实际发生的情况，例如可区分真正的生物识别不匹配（`BIOMETRIC_NO_MATCH`）与无法读取的自拍照（`BIOMETRIC_IMAGE_UNUSABLE`）。显示的 `status` 为默认功能状态；您配置的[部分匹配／无匹配操作](https://docs.didit.me/zh/core-technology/database-validation/database-validation-warnings.md)可以覆盖该状态。

**`MATCH`**：注册库已确认身份，且所有检查字段均匹配。

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "COL",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "col_migracion",
      "service_name": "Colombia - Migración Colombia foreigner status",
      "source_data": {
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "date_of_birth": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**：找到了证件号码，但一个或多个个人字段（通常是姓名或出生日期）未完全匹配。

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "COL",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "col_migracion",
      "service_name": "Colombia - Migración Colombia foreigner status",
      "source_data": {
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe"
      },
      "validation": {
        "date_of_birth": "no_match",
        "identification_number": "full_match"
      }
    }
  ]
}
```

**`NO_MATCH`**：注册库未返回与提交数据匹配的结果。

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "COL",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "col_migracion",
      "service_name": "Colombia - Migración Colombia foreigner status",
      "source_data": {
        "date_of_birth": "NO_MATCH",
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "date_of_birth": "no_match",
        "identification_number": "no_match"
      }
    }
  ]
}
```

## 返回数据

`source_data` 中实际返回的字段取决于注册库的返回内容。`col_migracion` 的自动生成示例目前记录了以下标准化结构：

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

## 定价与 SLA

哥伦比亚 - Migración Colombia 外籍人士移民状态查询仅在 Didit 从验证来源收到确定结果时计费。

* **单次调用价格：** \$1.20 USD。
* **计费：** 按每次成功查询计费。若注册库无法访问、必填字段缺失，或请求在到达来源前被拒绝，则不收取费用。
* **延迟：** 典型 p95 低于 2 秒。
* **可用性：** Didit 侧每季度 99.9%；下游来源的可用性因国家和数据集而异。

## 延伸阅读

* [哥伦比亚数据库核验概述](https://docs.didit.me/api-reference/database-validation/colombia.md)
* [数据库核验概述](https://docs.didit.me/zh/core-technology/database-validation/overview.md)
* [结果代码](https://docs.didit.me/zh/core-technology/database-validation/database-validation-outcome-codes.md)


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