์ฝ๋กฌ๋น์ โ ๊ตญ๋ฏผ ์ ๋ถ์ฆ ํ๋ฆฌ๋ฏธ์ (CC)
๋ชฉ์ : ์ฝ๋กฌ๋น์ CC(๊ตญ๋ฏผ์ ๋ถ์ฆ) ๋ฒํธ๋ฅผ ๊ณต์ ์ถ์ฒ์ ๋์กฐํ์ฌ ์ ํํ๋ ์ ์ ๋ ์ฝ๋๋ฅผ ๋ฐํํฉ๋๋ค(KYCยทAMLยท๊ท์ ์ ์ฐจ์ฉ). ๋ฑ๋ก์ ์ฑ๋ช
ยท์๋
์์ผยท๋ฐ๊ธ์ผ์ยท๋ฐ๊ธ์ง ๋ฐ, ์ถ์ฒ๊ฐ ์ ๊ณตํ๋ ๊ฒฝ์ฐ ์ฑ๋ณยท์์กด ์ฌ๋ถ๋ฅผ ํฌํจํ๋ฉฐ, ์๋ช
๊ธฐ๋ฐ ์ธ์ฆ ์ ๋ณด๊ฐ ์๋ต์ ํฌํจ๋ฉ๋๋ค. ์ ์ถ์ ๋ฒํธ๋ง โ ๋ฐ๊ธ์ผ์ ์๋ฒ์์ ์๋์ผ๋ก ํ์ ๋๋ฉฐ(์์ฒญ์ ๋ฌธ์ ์ ํยท๋ฐ๊ธ์ผ ๋ฏธํฌํจ), ์์ธ ์์ค์ cรฉdula extra์ ๋์ผํฉ๋๋ค. ๊ธฐ๋ณธ /v2/co/cedula ์๋ํฌ์ธํธ๋ณด๋ค ํฌ๋ ๋ง์ด ๋์ต๋๋ค(์ฐ์ ํด์๋ ๋จ๊ณ).
API ์ฐธ๊ณ โ
์๋ํฌ์ธํธโ
GET https://api.verifik.co/v2/co/cedula/premium
์๋ต: data(์ ์ถํ ๋ฒํธ์ ๋ํด ์ถ์ฒ๊ฐ ๋ฐํํ ์ ์ ์์ฑ), signature(ํ์ด๋ก๋์ ๋ํ ์ธ์ฆ ๋ฉํ๋ฐ์ดํฐ), id(์์ฒญ ์๋ณ์)๋ฅผ ๋ฐํํฉ๋๋ค. HTTP 404๋ ๋ณธ ์๋ํฌ์ธํธ ํ๋ฆ์์ ํด๋น ๋ฒํธ์ ๋ํ ์์ ํ ์ ์ ๋ ์ฝ๋๋ฅผ ๊ตฌ์ฑํ ์ ์์์ ๋ปํฉ๋๋ค. HTTP 409๋ ์์ ์ฐ๋ ์ ์
๋ ฅ ์ ํจ์ฑ ๊ฒ์ฌ์ ์คํจ(์: documentNumber ๊ธธ์ด)ํ์์ ๋ปํฉ๋๋ค. ์์ฒญ๋น ํฌ๋ ๋ง์ ๊ธฐ๋ณธ /v2/co/cedula๋ณด๋ค ๋์ต๋๋ค(์ฐ์ ํด์๋). CC๋ง ์ง์, ์ผ๋ฐ 5~10์๋ฆฌ ์ซ์.
ํค๋โ
| ์ด๋ฆ | ๊ฐ |
|---|---|
| Accept | application/json |
| Authorization | Bearer <token> |
๋งค๊ฐ๋ณ์โ
| ์ด๋ฆ | ํ์ | ํ์ | ์ค๋ช |
|---|---|---|---|
documentNumber | string | ์ | ์ฝ๋กฌ๋น์ CC(๊ตญ๋ฏผ์ ๋ถ์ฆ) ๋ฒํธ. ๋น์ซ์๋ ์ ๊ทํ๋ก ์ ๊ฑฐ๋๋ฉฐ, 5~10์ ์ซ์๋ก ์ ํจ์ฑ์ด ๊ฒ์ฌ๋ฉ๋๋ค. documentTypeยท๋ฐ๊ธ์ผ์ ๋ถํ์(ํ๋ฆฌ๋ฏธ์). |
์์ฒญโ
- GET
- POST
import axios from "axios";
const { data } = await axios.get("https://api.verifik.co/v2/co/cedula/premium", {
params: { documentNumber: "1234567890" },
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
},
});
console.log(data);
const { data } = await axios.post(
"https://api.verifik.co/v2/co/cedula/premium",
{ documentNumber: "1234567890" },
{
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
},
}
);
console.log(data);
์๋ตโ
- 200
- 404
- 409
์์ ํํ(์๋ฆฌํ์์, ์ค์ ์ธ๋ฌผ ์๋):
{
"data": {
"arrayName": ["GIVEN", "MIDDLE", "PATERNAL", "MATERNAL"],
"dateOfBirth": "1990-05-20",
"documentNumber": "1234567890",
"documentType": "CC",
"expeditionDate": "2015-08-12",
"expeditionPlace": {
"municipio": "์์ ์",
"departamento": "์์ ๋"
},
"firstName": "GIVEN MIDDLE",
"fullName": "GIVEN MIDDLE PATERNAL MATERNAL",
"gender": "HOMBRE",
"isAlive": true,
"lastName": "PATERNAL MATERNAL"
},
"signature": {
"dateTime": "April 21, 2026 9:34 PM",
"message": "Certified by Verifik.co"
},
"id": "XXXXX"
}
ํ๋ ๋ช ์นญ๊ณผ ์กด์ฌ ์ฌ๋ถ๋ ๊ณต์ ์ถ์ฒ ๋ฐ์ดํฐ์ ๋ฐ๋ผ ๋ฌ๋ผ์ง ์ ์์ต๋๋ค.
{
"code": "NotFound",
"message": "Record not found."
}
์์ ์ถ์ฒ์์ ์ผ์น ๋๋ ํ์ํ ๋ฐ์ดํฐ๋ฅผ ๋ฐํํ์ง ๋ชปํ ๊ฒฝ์ฐ(์: ๋ฐ๊ธ์ผ ํด์ ์คํจ) ๋ฐํ๋ฉ๋๋ค.
{
"code": "MissingParameter",
"message": "documentNumber maximum length: 10\n"
}
documentNumber ๊ธธ์ด๋ 5โ10์์
๋๋ค. ๋๋ฝ ๋๋ ํ์ ์ค๋ฅ ์ ๋ค๋ฅธ Joi ๋ฉ์์ง๊ฐ ๋ํ๋ ์ ์์ต๋๋ค.
์ฐธ๊ณ โ
- ๊ธฐ๋ณธ ์ ๋ถ ํ์ธ: ๊ตญ๋ฏผ ์ ๋ถ์ฆ(CCยทPPT) (
/v2/co/cedula). - ์๋ฌธ ์ ์ ๋ฌธ์: Colombian cรฉdula premium.