/FaceMatch
POST
/FaceMatch
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://facematch-v2-eu.core.idscan.cloud/FaceMatch"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new MultipartFormDataContent { new StringContent("") { Headers = { ContentType = new MediaTypeHeaderValue("application/octet-stream"), ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "FirstFaceImage", FileName = "file", } } }, new StringContent("") { Headers = { ContentType = new MediaTypeHeaderValue("application/octet-stream"), ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "SecondFaceImage", FileName = "file", } } }, new StringContent("{ \"additionalProperty\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json"), ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "AdditionalData", } } }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://facematch-v2-eu.core.idscan.cloud/FaceMatch"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"FirstFaceImage\"; filename=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"SecondFaceImage\"; filename=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"AdditionalData\"\r\nContent-Type: application/json\r\n\r\n{ \"additionalProperty\": \"example\" }\r\n-----011000010111000001101001--\r\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>") req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"FirstFaceImage\"; filename=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"SecondFaceImage\"; filename=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"AdditionalData\"\r\nContent-Type: application/json\r\n\r\n{ \"additionalProperty\": \"example\" }\r\n-----011000010111000001101001--\r\n");Request request = new Request.Builder() .url("https://facematch-v2-eu.core.idscan.cloud/FaceMatch") .post(body) .addHeader("Authorization", "Bearer <token>") .addHeader("Content-Type", "multipart/form-data; boundary=---011000010111000001101001") .build();
Response response = client.newCall(request).execute();const url = 'https://facematch-v2-eu.core.idscan.cloud/FaceMatch';const form = new FormData();form.append('FirstFaceImage', 'file');form.append('SecondFaceImage', 'file');form.append('AdditionalData', '{ "additionalProperty": "example" }');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}val client = OkHttpClient()
val mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001")val body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"FirstFaceImage\"; filename=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"SecondFaceImage\"; filename=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"AdditionalData\"\r\nContent-Type: application/json\r\n\r\n{ \"additionalProperty\": \"example\" }\r\n-----011000010111000001101001--\r\n")val request = Request.Builder() .url("https://facematch-v2-eu.core.idscan.cloud/FaceMatch") .post(body) .addHeader("Authorization", "Bearer <token>") .addHeader("Content-Type", "multipart/form-data; boundary=---011000010111000001101001") .build()
val response = client.newCall(request).execute()curl --request POST \ --url https://facematch-v2-eu.core.idscan.cloud/FaceMatch \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: multipart/form-data' \ --form FirstFaceImage=@file \ --form SecondFaceImage=@file \ --form 'AdditionalData={ "additionalProperty": "example" }'Determines the similarity score between two facial biometric images.
The Documents and Biometrics Core FaceMatch Service endpoint allows for two portrait images(selfie/face images) to be uploaded for comparison against each other. The endpoint will return a result after processing.The score is a value between 0 and 1, where score value of 0.8 or above is considered a Matched result, and score below 0.8 is a Not Matched result.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”x-correlation-id
string
Correlation Id for the request
Request Body
Section titled “Request Body”Media typemultipart/form-data
object
FirstFaceImage
First face image to be matched.
string format: binary
SecondFaceImage
Second face image to be matched.
string format: binary
AdditionalData
Key value pair for request configurations, for any additional data to be passed.
object
key
additional properties
string
RequestId
string
CorrelationId
string
Responses
Section titled “Responses”Returns a success on the Endpoint after processing the submitted facial images.This code does not indicate a success on the validation of the facial images themselves but rather a success on the call to the Endpoint. The face match result is in the response body (See Response Body section below).
Response of the face match service.
object
correlationId
string
score
Matching score of the query faces.
number format: float
result
Result of the match. Sets value of Matched, or Not Matched.
string
additionalDetails
Any additional details in key value pair.
object
key
additional properties
string
Response of the face match service.
object
correlationId
string
score
Matching score of the query faces.
number format: float
result
Result of the match. Sets value of Matched, or Not Matched.
string
additionalDetails
Any additional details in key value pair.
object
key
additional properties
string
Example generated
{ "score": 1, "result": "example", "additionalDetails": { "additionalProperty": "example" }}Response of the face match service.
object
correlationId
string
score
Matching score of the query faces.
number format: float
result
Result of the match. Sets value of Matched, or Not Matched.
string
additionalDetails
Any additional details in key value pair.
object
key
additional properties
string
Example generated
{ "score": 1, "result": "example", "additionalDetails": { "additionalProperty": "example" }}Error with the provided parameters, please, check the response provided to get more insights on the problem.
object
correlationId
string
errorMessage
string
errors
Array<string>
object
correlationId
string
errorMessage
string
errors
Array<string>
Example generated
{ "errorMessage": "example", "errors": [ "example" ]}object
correlationId
string
errorMessage
string
errors
Array<string>
Example generated
{ "errorMessage": "example", "errors": [ "example" ]}Internal error during our processing, please, get in touch with support so we can help you.
object
correlationId
string
errorMessage
string
errors
Array<string>
object
correlationId
string
errorMessage
string
errors
Array<string>
Example generated
{ "errorMessage": "example", "errors": [ "example" ]}object
correlationId
string
errorMessage
string
errors
Array<string>
Example generated
{ "errorMessage": "example", "errors": [ "example" ]}