๊ธ๋ก๋ฒ โ ์ ํ๋ฒํธ ์กฐํ
API ๋ ํผ๋ฐ์คโ
Endpointโ
https://api.verifik.co/v2/look-ups/phone
์ ํ๋ฒํธ ์กฐํ ์๋น์ค๋ ์ ์ธ๊ณ ํด๋ํฐ ๋๋ ์ ์ ๋ฒํธ๋ฅผ ๋ชฉ๋ก์ ์์ ์ ์ด๋ฆ ๋ฐ ๊ด๋ จ ํ๋กํ ํ๋์ ๋งค์นญํฉ๋๋ค. countryCode(์ซ์ ๊ตญ๊ฐ๋ฒํธ)์ phone(๊ตญ๊ฐ ์ ๋์ฌ ์๋ ๊ตญ๋ด ๋ฒํธ)๋ฅผ GET(์ฟผ๋ฆฌ) ๋๋ POST(JSON ๋ณธ๋ฌธ)์ผ๋ก ๋ณด๋
๋๋ค. ์ฑ๊ณต ์ data์๋ name, phone, countryCode๊ฐ ํฌํจ๋๋ฉฐ score, gender, about, jobTitle, companyName, phones, addresses, internetAddresses, imId, access, enhanced๊ฐ ์ฌ ์ ์์ต๋๋ค. ์จ๋ณด๋ฉ, ์ฌ๊ธฐ ํ์ง, ์ฐ๋ฝ์ฒ ํ์ธ์ ์ฌ์ฉํ์ธ์. OTP๋ก ๋จ๋ง๊ธฐ ์์ ๋ฅผ ์ฆ๋ช
ํ๋ ์ฉ๋๊ฐ ์๋๋๋ค.
SMS ๋๋ WhatsApp ์ผํ์ฉ ์ฝ๋๋ฅผ ๋ณด๋ด๋ ค๋ฉด ์ ํ๋ฒํธ ๊ฒ์ฆ์ ์ฐธ๊ณ ํ์ธ์.
ํค๋(Headers)โ
| ์ด๋ฆ | ๊ฐ |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer <token> |
๋งค๊ฐ๋ณ์(Parameters)โ
| ์ด๋ฆ | ํ์ | ํ์ | ์ค๋ช |
|---|---|---|---|
countryCode | string | ์ | ์ซ์ ๊ตญ๊ฐ๋ฒํธ์ด๋ฉฐ ISO2๊ฐ ์๋๋๋ค. ์: ์ฝ๋กฌ๋น์ 57, ๋ฏธ๊ตญ 1. |
phone | string | ์ | ์กฐํํ ํ์ ์ ๊ตญ๋ด ๋ฒํธ. ๊ตญ๊ฐ ์ ๋์ฌ, ๊ณต๋ฐฑ, ๋ฌธ์ฅ ๋ถํธ ์์ด ์ ๋ ฅํฉ๋๋ค. |
์์ฒญ(Request)โ
- JavaScript
- Python
import axios from "axios";
const options = {
method: "GET",
url: "https://api.verifik.co/v2/look-ups/phone",
params: { countryCode: "57", phone: "3006094511" },
headers: {
Accept: "application/json",
Authorization: "Bearer <your_token>",
},
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
import http.client
conn = http.client.HTTPSConnection("api.verifik.co")
payload = ""
headers = {}
conn.request("GET", "/v2/look-ups/phone?countryCode=57&phone=3006094511", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
์๋ต(Response)โ
- 200
- 404
- 409 (๋๋ฝ๋ ๋งค๊ฐ๋ณ์)
- 409 (์ ์คํธ๋ฆผ ๋ถ๊ฐ)
{
"data": {
"about": "",
"access": "",
"addresses": [],
"companyName": {},
"countryCode": "57",
"enhanced": "",
"gender": "",
"imId": "",
"internetAddresses": [],
"jobTitle": "",
"name": "JANE DOE",
"phone": "3006094511",
"phones": [],
"score": 0.9
},
"signature": {
"dateTime": "March 13, 2024 10:48 PM",
"message": "Certified by Verifik.co"
}
}
{
"code": "NotFound",
"message": "Record not found."
}
{
"code": "MissingParameter",
"message": "countryCode|phone is missing"
}
{
"code": "Conflict",
"message": "Endpoint out of service."
}
์ฐธ๊ณ (Notes)โ
- GET๊ณผ POST๋ฅผ ๋ชจ๋ ์ง์ํฉ๋๋ค. POST๋ ๋์ผํ ํ๋๋ฅผ JSON ๋ณธ๋ฌธ์ผ๋ก ๋ณด๋ ๋๋ค.
countryCode๋ ์ซ์ ๊ตญ๊ฐ๋ฒํธ(์:57)์ด๋ฉฐCO๊ฐ์ ISO2๊ฐ ์๋๋๋ค.phone์ ๊ตญ๋ด ๋ฒํธ๋ง ๋ณด๋ด์ธ์. ๊ตญ๊ฐ๋ฒํธ๋ฅผ ๋ค์ ๋ถ์ด์ง ๋ง์ธ์.name,phone,countryCode์ธ ํ๋กํ ํ๋๋ ์ ํ ์ฌํญ์ด๋ฉฐ ์์ค๊ฐ ์๋ตํ ์ ์์ต๋๋ค.- ์ด ๊ฒฝ๋ก์๋ ์๋๋ฐ์ค ํฝ์ค์ฒ๊ฐ ์์ต๋๋ค. ์กฐํ๋ ๋ผ์ด๋ธ ์์ค๋ฅผ ํธ์ถํฉ๋๋ค. ์ผ์ ์ฅ์ ๋ 409์
Endpoint out of service.๋ฅผ ๋ฐํํฉ๋๋ค. - 404๋ ๋ชฉ๋ก์ด ์๊ฑฐ๋ ๊ตญ๊ฐ๋ฒํธ๋ฅผ ์ ์ ์์์ ๋ปํฉ๋๋ค. ์ ๋ฃ ํด๋ผ์ด์ธํธ๋ 404์ ๊ณผ๊ธ๋์ง ์์ต๋๋ค.
- ์ด ์๋ํฌ์ธํธ๋ ํธ์ถ์๊ฐ ๋จ๋ง๊ธฐ๋ฅผ ์์ ํ์์ ์ฆ๋ช ํ์ง ์์ต๋๋ค. OTP ๊ฒ์ฆ์ ์ ํ๋ฒํธ ๊ฒ์ฆ์ ์ฌ์ฉํ์ธ์.