Get started
# API Endpoint
https://api.appducks.com/
We are helping developers deliver low-friction, state-of-the-art pattern recognition, link and behavior analysis, and OCR solution with just a single API call. Our mission is to leverage AI and Blockchain technologies to streamline the KYC process, reduce cost and customer friction, and make running KYC seamless for everyone. No machine learning expertise is required to build your next future intelligent application for your customers.
No API key is required. We accept only cups of coffee to help us keep awake and improve/add new APIs and maintain our resources. Thanks for supporting us ♡
Face Matching
# API Endpoint
https://api.appducks.com/face/matcher
# Sample Request
curl 'https://api.appducks.com/face/matcher' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data 'face1=[FACE1_URL]&face2=[FACE2_URL]'
To compare two faces, make a POST call to the
following url :
https://api.appducks.com/face/matcher
# Request Body:
{
face1:"https://i.imgur.com/bvT91HG.jpg",
face2:"https://i.imgur.com/MMcxImK.jpg"
}
# Response Example:
{
distance: 0.4584291735678101,
success: true
}
# Request Error
{
error: "error message xxxxxxx xxxxxx",
success: false
}
Request Body Fields
| Field | Type | Description |
|---|---|---|
| face1 | string | image URL. e.g. https://i.imgur.com/bvT91HG.jpg |
| face2 | string | image URL. e.g. https://i.imgur.com/MMcxImK.jpg |
Response Fields
| Field | Type | Description |
|---|---|---|
| distance | float/number | between 0 and 1. How closer the images to one another. You can set a threshold of your choice to define how identical the two faces are. We recommend 0.6 as threshold. But you can consider less number if you want to be more restricted in intolerant |
| success | boolean | true: the request is succeeded. false: unsuccessful request. |
| error | string | error message when having unsuccessful request. |
Use Cases
Here are some, but not all, use cases, I believe you have a lot in mind.
- KYC: you can compare a selfie with ID photos to make sure they are who they say they are.
- Dating Apps: you can create smart matching.
- Fun Apps: you can, for example, show user a celebrity they are very similar to in appearance.
- Family Apps: you can check whether your're more similar to your mom or dad.
- Many more ....
Passport doc ocr
# API Endpoint
https://api.appducks.com/ocr/passport
# Sample Request
curl 'https://api.appducks.com/ocr/passport' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data 'image=[PASSPORT_IMAGE]'
to scan passport document, make a POST call to the
following url :
https://api.appducks.com/ocr/passport
# Request Body:
{
image:"https://i.imgur.com/uGjALtm.png"
}
# Response Example:
{
result: {
name: "CHIN YONGHE",
country: { "name": "China","code": "CHN"},
passportNo: ["G2222888","N6311283","M1708130"],
dates: ["28 NOV 1963","12 DEC 2007","13 AUG 2017"]
},
fullText: "xxxxxxxx xxxxxx",
success : true
}
Request Body Fields
| Field | Type | Description |
|---|---|---|
| image | string | passport image URL. e.g. https://i.imgur.com/uGjALtm.png |
Response Fields
| Field | Type | Description |
|---|---|---|
| result | object | contains the main contents of any passport: passportNo, name, country, dates |
| success | boolean | true: the request is succeeded. false: unsuccessful request. |
| fullText | string | contains all the contents of the passport in an unformatted way. |
| error | string | error message when having unsuccessful request. |
Use Cases
Here are some, but not all, use cases, I believe you have a lot in mind.
- Know Your Customer
- Governmental/legal Apps
- Banking/Finance Apps
- Smart Flight Check-in
- Many More ...
Upload Image
# API Endpoint
https://api.appducks.com/image/upload
# Sample Request
curl -F 'image=[IMAGE_LOCAL_PATH]' https://api.appducks.com/image/upload
This endpoint is for uploading images in case you don't want to do any image uploading on your own server (we provided this endpoint for convenience and quick testing but we always encourage you to upload your images in your own server when you move to production env).
To upload image, make a POST call to the
following url :
https://api.appducks.com/image/upload
# Response Example:
{
success: true,
image:"https://image_url"
}
# Request Error
{
error: "error message xxxxxxx xxxxxx",
success: false
}
Request Body Fields
| Field | Type | Description |
|---|---|---|
| image | File (multipart/form-data) | Image file |
Response Fields
| Field | Type | Description |
|---|---|---|
| image | string | Image URL |
| success | boolean | true: the request is succeeded. false: unsuccessful request. |
| error | string | error message when having unsuccessful request. |
note: /image/upload endpoint is designed only for testing purposes. We do not recommend using it for your production as we wipe up all images every now and then. However, If you would like to use it for production, please email us so we can help you out.
Work in progress
# API Endpoint
would be available soon
We are working on identifying the authenticity of driver's license (taking Florida DL as our data to train). There are a few aspects we are currently taking in considerations:
 |
 |
 |
 |