/ExtractImage
POST
/ExtractImage
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://liveness-v2-eu.core.idscan.cloud/ExtractImage"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new MultipartFormDataContent { new StringContent("") { Headers = { ContentType = new MediaTypeHeaderValue("application/octet-stream"), ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "EncryptedPacket", FileName = "file", } } }, new StringContent("{ \"additionalProperty\": \"example\" }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json"), ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "Configurations", } } }, },};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://liveness-v2-eu.core.idscan.cloud/ExtractImage"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"EncryptedPacket\"; filename=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Configurations\"\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=\"EncryptedPacket\"; filename=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Configurations\"\r\nContent-Type: application/json\r\n\r\n{ \"additionalProperty\": \"example\" }\r\n-----011000010111000001101001--\r\n");Request request = new Request.Builder() .url("https://liveness-v2-eu.core.idscan.cloud/ExtractImage") .post(body) .addHeader("Authorization", "Bearer <token>") .addHeader("Content-Type", "multipart/form-data; boundary=---011000010111000001101001") .build();
Response response = client.newCall(request).execute();const url = 'https://liveness-v2-eu.core.idscan.cloud/ExtractImage';const form = new FormData();form.append('EncryptedPacket', 'file');form.append('Configurations', '{ "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=\"EncryptedPacket\"; filename=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Configurations\"\r\nContent-Type: application/json\r\n\r\n{ \"additionalProperty\": \"example\" }\r\n-----011000010111000001101001--\r\n")val request = Request.Builder() .url("https://liveness-v2-eu.core.idscan.cloud/ExtractImage") .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://liveness-v2-eu.core.idscan.cloud/ExtractImage \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: multipart/form-data' \ --form EncryptedPacket=@file \ --form 'Configurations={ "additionalProperty": "example" }'Extracts the JPG portrait captured inside an encrypted enhanced liveness packet.
Documents and Biometrics Core Extract Image endpoint provides the JPG portrait captured inside an encrypted enhanced liveness packet, allowing it to be used independently (e.g. as an anchor for a subsequent Facematch call) without waiting on a combined Biometrics check.
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
EncryptedPacket
string format: binary
Configurations
object
key
additional properties
string
RequestId
string
CorrelationId
string
Responses
Section titled “Responses”Returns a success on the Endpoint after processing the submitted encrypted packet. This code does not indicate a success on the extraction of a face from the packet itself but rather a success on the call to the endpoint. The extracted image is in the response body (See Response Body section below).
object
correlationId
string
imageData
string format: byte
error
object
error
string
errorCode
string
message
string
statusCode
string
object
correlationId
string
imageData
string format: byte
error
object
error
string
errorCode
string
message
string
statusCode
string
Example generated
{ "imageData": "example", "error": { "error": "example", "errorCode": "example", "message": "example", "statusCode": "example" }}object
correlationId
string
imageData
string format: byte
error
object
error
string
errorCode
string
message
string
statusCode
string
Example generated
{ "imageData": "example", "error": { "error": "example", "errorCode": "example", "message": "example", "statusCode": "example" }}No Content
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" ]}