BlinkID Verify API
Regions
The API is available in the following regions:
| Region | URL |
|---|---|
| US east | https://us-east.verify.microblink.com |
| EU | https://eu.verify.microblink.com |
| Canada | https://ca.verify.microblink.com |
v3
API reference for the /api/v3/verify endpoint:
Verify API v3
API reference
v2
API reference for the /api/v2/docver endpoint:
Verify API v2
API reference
Versioning
You can pick a specific image version, in addition to the broad v1-v2-v3 versioning scheme.
To do that, add a Microblink-Verify-Version header to your requests, for example:
Microblink-Verify-Version: 4000.5
We advise not pinning a version, unless you have a particular need for that specific version. The latest version (which you get when you don't specify one) has broader coverage and better capabilities.
- cURL
- JavaScript
- Python
- Go
curl https://us-east.verify.microblink.com/api/v3/verify \
--request POST \
--header 'Authorization: Basic <credentials>' \
--header 'Microblink-Verify-Version: 4000.5' \
--form 'imageFirstSide=@front_id.jpg' \
--form 'imageSecondSide=@back_id.png' \
--form 'consent={
"userId": "<your-id-for-the-end-user>",
"durationDays": 365
}'
const formData = new FormData()
formData.append('imageFirstSide', new Blob([]), 'front_id.jpg')
formData.append('imageSecondSide', new Blob([]), 'back_id.png')
formData.append('consent', '{
"userId": "<your-id-for-the-end-user>",
"durationDays": 365
}')
fetch('https://us-east.verify.microblink.com/api/v3/verify', {
method: 'POST',
headers: {
Authorization: 'Basic <credentials>',
'Microblink-Verify-Version': '4000.5'
},
body: formData
})
requests.post(
"https://us-east.verify.microblink.com/api/v3/verify",
headers={
"Authorization": "Basic <credentials>",
"Microblink-Verify-Version": "4000.5"
},
files=[
("imageFirstSide", open("front_id.jpg", "rb")),
("imageSecondSide", open("back_id.png", "rb"))
],
data={
"consent": "{\n \"userId\": \"<your-id-for-the-end-user>\",\n \"durationDays\": 365\n}"
}
)
package main
import (
"bytes"
"fmt"
"io"
"mime/multipart"
"net/http"
"os"
)
func main() {
requestUrl := "https://us-east.verify.microblink.com/api/v3/verify"
payload := &bytes.Buffer{}
writer := multipart.NewWriter(payload)
part, _ := writer.CreateFormFile("imageFirstSide", "front_id.jpg")
f, _ := os.Open("front_id.jpg")
defer f.Close()
_, _ = io.Copy(part, f)
part, _ = writer.CreateFormFile("imageSecondSide", "back_id.png")
f, _ = os.Open("back_id.png")
defer f.Close()
_, _ = io.Copy(part, f)
_ = writer.WriteField("consent", "{\n \"userId\": \"<your-id-for-the-end-user>\",\n \"durationDays\": 365\n}")
writer.Close()
req, _ := http.NewRequest("POST", requestUrl, payload)
req.Header.Set("Content-Type", writer.FormDataContentType())
req.Header.Add("Authorization", "Basic <credentials>")
req.Header.Add("Microblink-Verify-Version", "4000.5")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
List available versions
To fetch a list of all available cloud API versions, visit your region + /api/v1/system/versions, for example:
curl https://us-east.verify.microblink.com/api/v1/system/versions