Standard API

# Pseudo code
StringToSign = HttpMethod + "\n" + UrlPath + "\n" + Timestamp
# HttpMethod: such as `POST`, `GET`, `PUT`, `PATCH`, `DELETE`
# UrlPath: relative route path of the resource (exclude the domain). Example: `/v1/images`
# Timestamp: the time of the request in RFC3339 format. The client must also
  send this timestamp with the request in the `X-TV-Timestamp` header.

Signature = Base64(HmacSha256(AccessKeySecret, Utf8EncodingOf(StringToSign)))

StringToSign = HttpMethod + "\n" + UrlPath + "\n" + Timestamp + "\n" + ContentMD5;
# ContentMD: hash whole JSON content

{
    "payload": string, // AES-256 encrypted content
}

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.binary.Base64;
import okhttp3.*;

public class ApiSecurityExample {
  public static void main(String[] args) {
    try {

        // Provided by TV
        String accessKeyId     = "<YOUR ACCESS KEY>"
        String accessKeySecret = "<YOUR SECRET>"

        // Request info
        String method          = "POST"
        String urlPath         = "/v1/images"
        String rfc3339date    = "2019-04-21T18:00:15+07:00"

        Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
        SecretKeySpec secret_key = new SecretKeySpec(accessKeySecret.getBytes(), "HmacSHA256");
        sha256_HMAC.init(secret_key);

        // Create signature
        String stringToSign = String.format("%s\n%s\n%s", method, urlPath, rfc3339date)
        String signature = Base64.encodeBase64String(sha256_HMAC.doFinal(stringToSign.getBytes()));

        // Send request
        OkHttpClient client = new OkHttpClient().newBuilder().build();
        RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
            .addFormDataPart("file","portrait.jpg",
                RequestBody.create(MediaType.parse("application/octet-stream"),
                new File("/images/portrait.jpg")))
            .addFormDataPart("label","portrait")
            .build();
        Request request = new Request.Builder()
            .url("https://tv-staging.trustingsocial.com/api/v1/images")
            .method("POST", body)
            .addHeader("Authorization", String.format("TV %s:%s", accessKeyId, signature))
            .addHeader("X-TV-Timestamp", rfc3339date)
            .build();
        Response response = client.newCall(request).execute();
    }
    catch (Exception e){
        System.out.println("Error");
    }
   }
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/images \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F file=@/images/portrait.jpg \
-F label=portrait

{\"raw\": \"value\"}  // raw decoded string of the QR code.

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/images \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-F 'file=@"images/portrait.jpg"' \
-F 'label="portrait"'

{
    "data": {
        "image_id": string, // ID of the uploaded image in StoreDB
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "image_id": "20b457d2-cf11-4c2b-a491-8137ae6b0bc8"
    }
}

curl -X GET \
https://tv-staging.trustingsocial.com/api/v1/images/7db00808-0416-45cf-a5cb-3b6dfbd7bb74 \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json'

{
    "data": {},
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/files \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-F 'file=@"videos/frames.mp4"'
-F 'label="video"'

{
  "data": {
    "file_id": string, // ID of the uploaded file in StoreDB
  },
  "errors": [
      {
        "code": string,
        "message": string,
        "detail": {
            "field": string, // optional, which parameter is invalid.
            ... // any other information that can be useful for client
        },
      },
      ... // other errors
  ]
}

{
  "data": {
    "file_id": "20b457d2-cf11-4c2b-a491-8137ae6b0bc8"
  }
}

curl -X GET \
https://tv-staging.trustingsocial.com/api/v1/files/7db00808-0416-45cf-a5cb-3b6dfbd7bb74 \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json'

{
    "data": {},
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "image1": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "image2": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "type": string
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/compare_faces_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "image1": {
        "id": "7db00808-0416-45cf-a5cb-3b6dfbd7bb74"
    },
    "image2": {
        "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
    }
}
'

{
    "data": {
        "status": string, // "success" or "failure"
        "image1": {
            "id": string,
            "transformed_image_id": string // optional, just in case the image is transformed
            "faces": [
                {
                    "id": string, // id of the face in image1
                    "bounding_box": {
                        "top": int, // the top edge of the box
                        "right": int, // the right edge of the box
                        "bottom": int, // the bottom edge of the box
                        "left": int, // the left edge of the box
                        "angle": int // the angle at which the box is rotated
                    }
                },
                ... // other faces in image1
            ],
        },
        "image2": {
            "id": string,
            "transformed_image_id": string // optional, just in case the image is transformed
            "faces": [
                {
                    "id": string, // id of the face in image2
                    "bounding_box": {
                        "top": int, // the top edge of the box
                        "right": int, // the right edge of the box
                        "bottom": int, // the bottom edge of the box
                        "left": int, // the left edge of the box
                        "angle": int // the angle at which the box is rotated
                    }
                },
                ... // other faces in image2
            ],
        },
        "compare_faces": [
            {
                "face1_id": string, // id of the face in image1
                "face2_id": string, // id of the face in image2
                "score": float, // how likely that face1 and face2 are matched (0-1)
                "result": string // "matched", "unmatched", "unsure"
            },
            ... // other pair of faces in image1 and image2
        ],
        "request_id": string // return request id to the client and can use request-id to check logs.
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "compare_faces": [
            {
                "face1_id": "abdba678-b680-4b62-bc4b-d9b8fb37e8e4",
                "face2_id": "d43bf504-f1a3-4799-9bda-e5709ae7aa69",
                "result": "matched",
                "score": 0.7381135644418032
            },
            {
                "face1_id": "ae7a6cd2-4f5b-45b3-955f-844b1bc6d95a",
                "face2_id": "d43bf504-f1a3-4799-9bda-e5709ae7aa69",
                "result": "unmatched",
                "score": 0.5098310116475188
            }
        ],
        "image1": {
            "faces": [
                {
                    "bounding_box": {
                        "angle": 0,
                        "bottom": 446,
                        "left": 357,
                        "right": 550,
                        "top": 172
                    },
                    "id": "abdba678-b680-4b62-bc4b-d9b8fb37e8e4"
                },
                {
                    "bounding_box": {
                        "angle": 0,
                        "bottom": 530,
                        "left": 57,
                        "right": 254,
                        "top": 263
                    },
                    "id": "ae7a6cd2-4f5b-45b3-955f-844b1bc6d95a"
                }
            ],
            "id": "f3f6f8b5-2ac0-4734-a4b5-836c6c300b0b",
            "transformed_image_id": ""
        },
        "image2": {
            "faces": [
                {
                    "bounding_box": {
                        "angle": 0,
                        "bottom": 369,
                        "left": 504,
                        "right": 559,
                        "top": 296
                    },
                    "id": "d43bf504-f1a3-4799-9bda-e5709ae7aa69"
                }
            ],
            "id": "639058a6-0631-4bfd-a718-bc72c2695daf",
            "transformed_image_id": ""
        },
        "request_id": "b6e90aa2-a2d2-44bb-b4d5-cd4b92d0cdae",
        "status": "success"
    }
}

{
    "images": [
        {
            "id": string,
            "base64": string,
            "label": string,
            "metadata": string_json,
        },
        {
            "id": string,
            "base64": string,
            "label": string,
            "metadata": string_json,
        }
    ],
    "gesture_images":[
        {
            "gesture": string,
            "images": [
                {
                        "id": string,
                        "base64": string,
                        "label": string,
                        "metadata": string_json,
                    },
                    {
                        "id": string,
                        "base64": string,
                        "label": string,
                        "metadata": string_json,
                    }
            ],
        }
    ],
    "videos": [
        {
            "id": string,
            "metadata": string_json,
            "frames": [
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                    "metadata": string_json,
                },
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                    "metadata": string_json,
                },
                // other frames
            ],
        },
        {
            "id": string,
            "metadata": string_json,
            "frames": [
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                    "metadata": string_json,
                },
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                    "metadata": string_json,
                },
                // other frames
            ],
        }
    ],
    "metadata": dictionary
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/verify_face_liveness_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "images": [
        {
            "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
        },
        {
            "id": "c5a2a405-f152-4248-b746-3af76b241ef7"
        },
        {
            "id": "5d0345f7-da7c-44e8-bd6c-a8c08c806227"
        }
    ],
    "gesture_images": [
        {
            "gesture": "left",
            "images": [
                {
                    "id": "d849a3ce-d209-4605-99a7-3d369234fd5e"
                }
            ]
        },
        {
            "gesture": "up",
            "images": [
                {
                    "id": "551fc06a-14fd-44dc-8838-abe895007c36"
                }
            ]
        },
        {
            "gesture": "right",
            "images": [
                {
                    "id": "536d2457-bfc0-4249-85f2-8c4053bdec58"
                }
            ]
        }
    ],
    "videos": [
        {
            "id": "433331b5-e1d4-433f-84e6-2260ec6bee92"
        },
        {
            "id": "3b4bf7b6-088b-4931-9279-9259f5c34fe3"
        }
    ]
}
'

{
    "data": {
        "status": string, "success" or "failure"
        "is_live": bool, // the face is live or not
        "score": float // how likely that the face is live (0-1)
        "images": [
            {
                "id": string, // ID of the image
                "is_live": bool, // liveness result of this image only
                "score": float // how likely that the face is live (0-1)
            },
            ... // up to 3 images
        ],
        "main_image_id": string, // optional return main image id use to compare faces and face retrieval
        "request_id": string // return request id to the client and can use request-id to check logs.
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "details": null,
        "images": [
            {
                "id": "0e33129a-c9ec-4e22-bf53-78d496bb1f37",
                "is_live": true,
                "score": 0.981541368665434
            },
            {
                "id": "9687e2c9-4f99-46e8-a4d9-4469d61de829",
                "is_live": true,
                "score": 0.9879801868228469
            },
            {
                "id": "007b943c-eda3-4b08-8c80-da258cb69eac",
                "is_live": true,
                "score": 0.9843504686937438
            },
            {
                "id": "d98d5b5c-30e0-43c2-b812-7d53f0fc585d",
                "is_live": true,
                "score": 0.9493469735404098
            },
            {
                "id": "010b5aa5-ef2a-47fe-937d-b5d10dfad443",
                "is_live": true,
                "score": 0.9687573370988268
            },
            {
                "id": "845c3a3b-623a-4de0-8f13-e43115239e5b",
                "is_live": true,
                "score": 0.9464235386207961
            }
        ],
        "is_live": true,
        "request_id": "93029850-924c-465a-baa6-27d843cbb1ba",
        "score": 0.9999999862517992,
        "status": "success",
        "videos": [
            {
                "is_live": true,
                "score": 1
            }
        ]
    }
}

{
    "videos": [
        {
            "id": string,
            "metadata": string_json,
            "frames": [
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                    "metadata": string_json,
                },
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                    "metadata": string_json,
                },
                // other frames
            ],
        },
        {
            "id": string,
            "metadata": string_json,
            "frames": [
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                    "metadata": string_json,
                },
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                    "metadata": string_json,
                },
                // other frames
            ],
        }
    ]
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/verify_face_video_liveness_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "videos": [
        {
            "id": "433331b5-e1d4-433f-84e6-2260ec6bee92"
        },
        {
            "id": "3b4bf7b6-088b-4931-9279-9259f5c34fe3"
        }
    ]
}
'

{
    "data": {
        "status": string, "success" or "failure"
        "is_live": bool, // the face is live or not
        "score": float // how likely that the face is live (0-1)
        "videos": [
            {
                "id": string, // ID of the video
                "is_live": bool, // liveness result of this video only
                "score": float // how likely that the face is live (0-1)
            },
            ... // up to 3 images
        ],
        "request_id": string // return request id to the client and can use request-id to check logs.
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "is_live": true,
        "request_id": "93029850-924c-465a-baa6-27d843cbb1ba",
        "score": 0.9999999862517992,
        "status": "success",
        "videos": [
            {
                "id": "c5c7d001-0c62-4b31-8714-3bc256a8635c",
                "is_live": true,
                "score": 1
            }
        ]
    }
}

{
    "card_type": string,
    "image1": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "image2": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "qr1_images": [{
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    }],
    "qr2_images": [{
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    }],
    "qr1_videos": [
            {
                "id": string,
                "metadata": string_json,
                "frames": [
                    {
                        "base64": string,
                        "label": string,
                        "index": int,
                    },
                    {
                        "base64": string,
                        "label": string,
                        "index": int,
                    },
                    // other frames
                ],
            },
            {
                "id": string,
                "metadata": string_json,
                "frames": [
                    {
                        "base64": string,
                        "label": string,
                        "index": int,
                    },
                    {
                        "base64": string,
                        "label": string,
                        "index": int,
                    },
                    // other frames
                ],
            }
       ],
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/read_id_card_info_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "card_type": "vn.national_id",
    "image1": {
        "id": "7db00808-0416-45cf-a5cb-3b6dfbd7bb74"
    },
    "image2": {
        "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
    }
}
'

{
    "data": {
        "request_id": string, // ID of the request
        "status": string, // "success" or "failure"
        "image1": {
            "id": string,
            "transformed_image_id": string, // optional, just in case the image is transformed
            "card_box": {
                "top_left": { "x": float, "y": float },
                "top_right": { "x": float, "y": float },
                "bottom_left": { "x": float, "y": float },
                "bottom_right": { "x": float, "y": float },
            },
            "qr": {
                "parsed": [ // list of parsed information from QR code
                    {
                        "field": string, // uid, name, dateOfBirth, careOf, ...
                        "value": string,
                    },
                    ... // other fields
                ],
                "raw": string, // raw XML string decoded from QR code,
                "face_image_id": string, // the extracted image from Secure QR, it's available for India only
            }
            "ocr": {
                "parsed": [ // list of parsed information from OCR
                    {
                        "field": string, // uid, name, dateOfBirth, careOf, ...
                        "value": string,
                    },
                    ... // other fields
                ],
                "raw": [ // list of raw OCR text boxes
                    {
                        "text": string, // detected text
                        "bounding_box": [
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            }
                        ],
                        "label": string, // label of the box
                        "line": int,
                        "group": int,
                    },
                    ... // other text boxes
                ]
            },
            "mrz": {
                "parsed": [ // list of parsed information from mrz
                    {
                        "field": string, // id no, name, dateOfBirth,...
                        "value": string,
                    },
                    ... // other fields
                ],
                "raw": [ // list of raw OCR text boxes of MRZ's area
                    {
                        "text": string, // detected text
                        "bounding_box": [
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            }
                        ],
                        "label": string, // label of the box
                        "line": int,
                        "group": int,
                    },
                    ... // other text boxes
                ]
            },
        },
        "image2": {
            "id": string,
            "transformed_image_id": string, // optional, just in case the image is transformed
            "card_box": {
                "top_left": { "x": float, "y": float },
                "top_right": { "x": float, "y": float },
                "bottom_left": { "x": float, "y": float },
                "bottom_right": { "x": float, "y": float },
            },
            "qr": {
                "parsed": [ // list of parsed information from QR code
                    {
                        "field": string, // uid, name, dateOfBirth, careOf, ...
                        "value": string,
                    },
                    ... // other fields
                ],
                "raw": string, // raw XML string decoded from QR code
                "face_image_id": string, // the extracted image from Secure QR, it's available for India only
            }
            "ocr": {
                "parsed": [ // list of parsed information from OCR
                    {
                        "field": string, // uid, name, dateOfBirth, careOf, ...
                        "value": string,
                    },
                    ... // other fields
                ],
                "raw": [ // list of raw OCR text boxes
                    {
                        "text": string, // detected text
                        "bounding_box": [
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            }
                        ],
                        "label": string, // label of the box
                        "line": int,
                        "group": int,
                    },
                    ... // other text boxes
                ]
            },
            "mrz": {
                "parsed": [ // list of parsed information from mrz
                    {
                        "field": string, // id no, name, dateOfBirth,...
                        "value": string,
                    },
                    ... // other fields
                ],
                "raw": [ // list of raw OCR text boxes of MRZ's area
                    {
                        "text": string, // detected text
                        "bounding_box": [
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            },
                            {
                                "x": float,
                                "y": float,
                            }
                        ],
                        "label": string, // label of the box
                        "line": int,
                        "group": int,
                    },
                    ... // other text boxes
                ]
            },
        },
        "card_information": [ // merged and normalized information from QR and OCR of both image1 and image2
            {
                "field": string, // field name ("identity_number", "full_name", "first_name", "middle_name", "last_name", "birth_date", "address_level_1_(city)", "address_level_1_(city)_code",...)
                "value": string, // value of the field ("123456789", "Sohit Gour", "1998-06-23")
                "confidence_verdict": string, // verdict of value ("SURE", "UNSURE", ""), empty mean Not Available. This field is shown if client enable 'enable_evaluate_confidence'
                "confidence_score": float, // confidence score of predict value. This field is shown if client enable 'enable_evaluate_confidence'
            },
            ... // other pair of card information
        ],
        "request_id": string // return request id to the client and can use request-id to check logs.
    },
    "errors": [
        {
            "code": string, // "unexpected_error", "image_too_dark", "image_too_bright", ...
            "message": string, // message to clarify the error code
            "detail": {
                ... // any information to help trace and debug
            }
        },
        ... // other errors
    ]
}

{
  "data": {
    "card_information": [
      {
        "confidence_score": 1,
        "confidence_verdict": "SURE",
        "digit_confidence_scores": [
          1,
          1,
          1,
          1,
          1,
          1,
          1,
          1,
          1,
          1,
          1,
          1
        ],
        "field": "id",
        "value": "012345678910"
      },
      {
        "confidence_score": 1,
        "confidence_verdict": "SURE",
        "field": "name",
        "value": "NGUYỄN VĂN A"
      },
      {
        "confidence_score": 1,
        "confidence_verdict": "SURE",
        "field": "dob",
        "value": "01/01/2001"
      },
      {
        "confidence_score": 1,
        "confidence_verdict": "SURE",
        "field": "gender",
        "value": "NAM"
      },
      {
        "confidence_score": 1,
        "confidence_verdict": "SURE",
        "field": "address",
        "value": "132 HÀM NGHI, PHƯỜNG BẾN THÀNH, QUẬN 1, TP.HỒ CHÍ MINH"
      },
      {
        "confidence_score": 1,
        "confidence_verdict": "SURE",
        "field": "expiry_date",
        "value": "01/01/2026"
      },
      {
        "confidence_score": 1,
        "confidence_verdict": "SURE",
        "field": "issue_date",
        "value": "25/07/2022"
      },
      ...,
      {
        "field": "card_type",
        "value": "vn.cccd_new"
      },
      {
        "field": "card_label",
        "value": "vn.cccd_new.front"
      },
      {
        "field": "nationality",
        "value": "VIỆT NAM"
      }
    ],
    "image1": {
      "card_box": {
        "bottom_left": {
          "x": 108.75621096603572,
          "y": 532.4366315092892
        },
        "bottom_right": {
          "x": 808.5273808091879,
          "y": 518.4647938594222
        },
        "top_left": {
          "x": 119.84309555403888,
          "y": 122.66592678334564
        },
        "top_right": {
          "x": 785.999680519104,
          "y": 111.78477731919848
        }
      },
      "id": "8c72e2b0-b0d9-4c4d-bb76-5ca6262af103",
      "mrz": {
        "parsed": null,
        "raw": null
      },
      "nfc": {
        "parsed": null,
        "raw": null
      },
      "ocr": {
        "parsed": [
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "digit_confidence_scores": [
              1,
              1,
              1,
              1,
              1,
              1,
              1,
              1,
              1,
              1,
              1,
              1
            ],
            "field": "id",
            "value": "012345678910"
          },
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "field": "name",
            "value": "NGUYỄN VĂN A"
          },
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "field": "dob",
            "value": "01/01/2001"
          },
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "field": "gender",
            "value": "NAM"
          },
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "field": "address",
            "value": "132 HÀM NGHI, PHƯỜNG BẾN THÀNH, QUẬN 1, TP.HỒ CHÍ MINH"
          },
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "field": "expiry_date",
            "value": "01/01/2026"
          },
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "field": "issue_date",
            "value": "25/07/2022"
          },
          ...
        ],
        "raw": [
          {
            "bounding_box": [
              {
                "x": 281.2383117675781,
                "y": 166.15625
              },
              {
                "x": 518.7890625,
                "y": 166.15625
              },
              {
                "x": 518.7890625,
                "y": 198.109375
              },
              {
                "x": 281.2383117675781,
                "y": 198.109375
              }
            ],
            "char_probs": [
              -0.000690460205078125,
              -0.0007172819459810853,
              -0.0007648453465662897,
              -0.0007659182301722467,
              -0.0007841570768505335,
              -0.0008823807002045214,
              -0.0008858377696014941,
              -0.0008965665474534035,
              -0.0009963397169485688,
              -0.0009986046934500337,
              -0.000998962321318686,
              -0.0010205389698967338,
              -0.001036274479702115,
              -0.001036274479702115
            ],
            "entropy": 0.004665346350520849,
            "group": 0,
            "label": 1,
            "line": 0,
            "text": "012345678910"
          },
          ...
        ]
      },
      "qr": {
        "parsed": [
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "field": "id",
            "value": "012345678910"
          },
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "field": "id_1",
            "value": ""
          },
          {
            "confidence_score": 1,
            "confidence_verdict": "SURE",
            "field": "name",
            "value": "NGUYỄN VĂN A"
          },
          ...
        ],
        "raw": "012345678910||NGUYỄN VĂN A|01012001|Nam|132 Hàm Nghi, Phường Bến Thành, Quận 1, TP.Hồ Chí Minh|25072022"
      },
      "transformed_image_id": "0133973f-e0ea-43e1-97fe-6377eff3a4ff"
    },
    "image2": null,
    "status": "success"
  }
}

{
    "index": int, // index of the page, starts from 1
    "label": string, // label of the page image
    "metadata": {...}, // optional, any key-value metadata to store with the page image
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/convert_pdf_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-F 'file=@"portrait.pdf"' \
-F 'pages="[{\"index\":1, \"label\": \"portrait\"}]"'

{
    "data": {
        "status": string, "success" or "failure"
        "images": [ // list of converted images
            {
                "id": string, // ID of the image
                "page" int, // page number (1-indexed) in the PDF file
                "label": string, // label of the image
            },
        ],
        "request_id": string // return request id to the client and can use request-id to check logs.
    }
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "images": [
            {
                "id": "081083a6-55e1-4eae-9c54-523edbae4390",
                "label": "portrait",
                "page": 1
            }
        ],
        "request_id": "0866d821-9548-4445-936c-3a593345fe11",
        "status": "success"
    }
}

{
    "image": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "selfie_type": string,
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/verify_portrait_sanity_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "image": {
        "id": "7db00808-0416-45cf-a5cb-3b6dfbd7bb74"
    }
}
'

{
    "data": {
        "status": string, "success" or "failure"
        "portrait_sanity": { // only return the first issue found if any
            "verdict": string, // "good" or some alerts, see below.
            "score": float, // range 0-1, how much confidence about the verdict
        },
        "request_id": string // return request id to the client and can use request-id to check logs.
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
  "data": {
    "image": {
      "id": "4368143d-9066-4f3d-ab22-4e0b6dd9b274"
    },
    "portrait_sanity": {
      "score": 1,
      "verdict": "good"
    },
    "status": "success"
  }
}

{
    "card_type": string,
    "image1": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "image2": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "special_id_type": string,
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/verify_id_card_sanity_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "card_type": "vn.national_id",
    "image1": {
        "id": "7db00808-0416-45cf-a5cb-3b6dfbd7bb74"
    },
    "image2": {
        "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
    }
}
'

{
    "data": {
        "status": string, "success" or "failure"
        "image1": {
            "id": string,
            "transformed_image_id": string, // optional, just in case the image is transformed
            "card_box": {
                "top_left": { "x": int, "y": int },
                "top_right": { "x": int, "y": int },
                "bottom_left": { "x": int, "y": int },
                "bottom_right": { "x": int, "y": int },
            },
        },
        "image2": {
            "id": string,
            "transformed_image_id": string // optional, just in case the image is transformed
            "card_box": {
                "top_left": { "x": int, "y": int },
                "top_right": { "x": int, "y": int },
                "bottom_left": { "x": int, "y": int },
                "bottom_right": { "x": int, "y": int },
            },
        },
        "card_sanity": { // only return the first issue found if any
            "verdict": string, // "good" or some alerts, see below.
            "score": float, // range 0-1. if verdict=good, then score=1, other verdicts the higher value denotes the more possibility the card is unqualified.
            "info": string, // optional. eg. return the last 6 digits of the CCCD Chip via this field.
        },
        "request_id": string // return request id to the client and can use request-id to check logs.
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
  "data": {
    "card_sanity": {
      "score": 1,
      "verdict": "good"
    },
    "image1": {
      "card_box": null,
      "id": "3ebebfe1-cf6c-4c7a-bee2-2dba834a6f1d",
      "transformed_image": null
    },
    "image2": null,
    "status": "success"
  }
}

{
    "image": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
        "image2": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "qr1_images": [{
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    }],
    "qr2_images": [{
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "card_type": string,
    "level": string,
    "videos": [
        {
            "id": string,
            "metadata": string_json,
            "frames": [
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                },
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                },
                // other frames
            ],
        },
        {
            "id": string,
            "metadata": string_json,
            "frames": [
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                },
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                },
                // other frames
            ],
        }
    ],
    "qr1_videos": [
        {
            "id": string,
            "metadata": string_json,
            "frames": [
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                },
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                },
                // other frames
            ],
        },
        {
            "id": string,
            "metadata": string_json,
            "frames": [
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                },
                {
                    "base64": string,
                    "label": string,
                    "index": int,
                },
                // other frames
            ],
        }
    ],
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/detect_id_card_tampering_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "card_type": "vn.national_id",
    "image": {
        "id": "7db00808-0416-45cf-a5cb-3b6dfbd7bb74"
    },
    "image2": {
        "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
    }
}
'

{
    "data": {
        "status": string, // "success" or "failure"
        "card_tampering":
        {
            "score": float,
            "verdict": string // final verdict. Reference to the verdict values table.
            "details":[ // list of results for each checked feature.
                {
                    "verdict": string, // verdict result on this checked feature. Reference to the verdict values table.
                    "score": float,
                    "info": string, // optional, information returned with this feature. Available with tax_name_unmatched verdict.
                },
                ... // other
            ]
        },
        "image_id": string, // ID of the image
        "image2_id":string, // ID of the image2
        "request_id": string // return request id to the client and can use request-id to check logs.
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
  "data": {
    "card_tampering": {
      "details": [
        {
          "name": "alert_1",
          "score": 1,
          "verdict": "card_expired"
        }
      ],
      "score": 1,
      "verdict": "alert"
    },
    "image2_id": "185aed08-53c7-433d-8dcd-e99f5131230f",
    "image_id": "4ba8de0e-9758-43fb-ac65-6f32ad3392d1",
    "status": "success"
  }
}

{
    "image": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "return_embedding": bool,
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/detect_faces_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "image": {
        "id": "7db00808-0416-45cf-a5cb-3b6dfbd7bb74"
    }
}
'

{
    "data": {
        "request_id": string,
        "status": string, // "success" or "failure"
        "image": {
            "id": string,
            "transformed_image_id": string // optional, just in case the image is transformed
            "faces": [
                {
                    "id": string, // id of the face in image
                    "bounding_box": {
                        "top": int, // the top edge of the box
                        "right": int, // the right edge of the box
                        "bottom": int, // the bottom edge of the box
                        "left": int, // the left edge of the box
                        "angle": int // the angle at which the box is rotated
                    },
                    "embedding": []float, // embedding of face
                },
                ... // other faces in image
            ],
        },
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
  "data": {
    "image": {
      "faces": [
        {
          "bounding_box": {
            "angle": 0,
            "bottom": 568,
            "left": 123,
            "right": 257,
            "top": 402
          },
          "embedding": [
            0.09560582041740417,
            -0.15577684342861176,
            -0.009643876925110817,
            -0.019479934126138687,
            0.0861940085887909,
            -0.016617512330412865,
            ...
          ],
          "id": "2cc3a440-3390-407a-914c-66a63e6eda33"
        }
      ],
      "id": "e5e32ef1-296e-4385-8f23-9eb7e6512800",
      "transformed_image_id": ""
    },
    "status": "success"
  }
}

{
    "selfie": [{
        "id": string,
        "base64": string,
    }],
    "original": {
        "id": string,
        "base64": string
    }
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/face_otp \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "selfie": [
        {
            "id": "7db00808-0416-45cf-a5cb-3b6dfbd7bb74"
        }
    ],
    "original": {
        "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
    }
}
'

{
    "data": {
        "status": string, // "success" or "failure"
        "is_live": bool, // the face is live or not
        "compare_faces": {
            "score": float, // how likely that face1 and face2 are matched (0-1)
            "result": string // "matched", "unmatched", "unsure"
        },
        "request_id": string // return request id to the client and can use request-id to check logs.
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
  "data": {
    "compare_faces": {
      "face1_id": "349ac5cd-2bd1-4bff-8c10-1cdacdd4c66d",
      "face2_id": "57263098-9c07-4220-888f-f8c4b73d4c1d",
      "result": "matched",
      "score": 0.9256071887745998
    },
    "is_live": true,
    "status": "success"
  },
  "errors": null
}

{
    "image": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "enable_update_metadata": bool,
    "collection": string,
    "type": int
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/index_faces_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "image": {
        "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
    }
}
'

{
    "data": {
        "request_id": string,
        "image": {
          "id": string, // id of the image
          "transformed_image_id": string // optional, just in case the image is transformed
        },
        "status": string, // "success" or "failure"
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "status": "success",
        "image": {
          "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
        },
        "request_id": "dfdef016-e89b-4da4-ae17-5844f909c947"
    }
}

{
    "image": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
    },
    "collection": string,
    "collections": []string,
    "type": int,
    "special_id_type": string,
    "max_faces": int
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/search_faces_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "image": {
        "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
    }
}
'

{
    "data": {
        "request_id": string,
        "status": string, // "success" or "failure"
        "image": {
          "id": string, // id of the image
          "transformed_image_id": string // optional, just in case the image is transformed
        },
        "faces": [   // Result for single collection. support search multiple faces. Each array is result of each face
            [
                {
                    "id": string, // id of the face in image
                    "image_id": string, // id of original image
                    "score": float, // score similar between 2 faces
                    "metadata": [ // list of meta data information of this face
                            {
                                "field": string, // application_id, national_id, ...
                                "value": primitive_type, // when index key=value then the value should a primitive type as string, int, float, boolean
                            },
                            ... // other fields
                },
                ... // other face matched of first face in image
            ],
            [
                ... // list face matches of another face in image
            ],
        ],
        "faces_in_collection": {
            "collection_name1":[   // Result for multiple collections. support search multiple faces. Each array is result of each face
                    [
                    {
                        "id": string, // id of the face in image
                        "image_id": string, // id of original image
                        "score": float, // score similar between 2 faces
                        "metadata": [ // list of meta data information of this face
                                {
                                    "field": string, // application_id, national_id, ...
                                    "value": primitive_type, // when index key=value then the value should a primitive type as string, int, float, boolean
                                },
                                ... // other fields
                    },
                    ... // other face matched of first face in image
                ],
                [
                    ... // list face matches of another face in image
                ],
            ],
                "collection_name2": ... // other result on collection_name2
        }
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "status": "success",
        "image": {
          "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
        },
        "faces": [
            [
                {
                    "id": "e8cd85a1-e1aa-4750-a0c9-1525fb524eed",
                    "image_id": "91b2c846-b701-4cc2-8061-1f243c50cc52",
                    "score": 1,
                    "metadata": [
                        {
                            "field": "app_id",
                            "value": 3333
                        },
                        {
                            "field": "national_id",
                            "value": 4444
                        }
                    ]
                },
                {
                    "id": "b05ed8b6-5d29-47a1-a934-f59f0197cea0",
                    "image_id": "ddb80011-c861-4904-a25f-c000cb969b61",
                    "score": 1,
                    "metadata": null
                },
                ...
            ]
        ],

        "request_id": "426bef5c-77ff-49e5-b0cd-b66651ac6427"
    }
}

{
    "image": {
        "id": string,
        "base64": string,
        "label": string,
        "metadata": string_json,
        "embedding": []float,
    },
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/alert_faces_sync \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "image": {
        "id": "a4facba3-334b-41fb-97e3-4766cb70ae29"
    }
}
'

{
    "data": {
        "request_id": string,
        "status": string, // "success" or "failure"
        "faces": [   // support search multiple faces. Each array is result of each face
            [
                {
                    "name": string, // face name 1, 2, 3...
                    "score": float, // score similar between 2 faces
                    "created_at": date, // data time RFC3339 ex. 2006-01-02T15:04:05Z07:00
                    "applied_service": string, // kind of service that user applied
                    ... // other fields
                },
                ... // other face matched of first face in image
            ],
            [
                ... // list face matches of another face in image
            ],
        ],
        "history": [   // support history multiple faces. Each array is result of each face
            [
                {
                    "period": string, // time period as last_1day, last_7day, last_30day, last_180day
                    "num_suspect_faces": int, // number of matched faces in suspect DB
                    "num_member_suspect_faces": int, // number of members with face in suspect DB
                    "num_inquiry": int, // number of total inquiries made by all the member for this face
                    "num_member_inquiry": int, // Number of members which made the inquiry for this face in specific period
                },
                ... // other history for other time periods
            ],
            [
                ... // list history of another face in image
            ],
        ],
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "status": "success",
        "image": {
            "id": "2a5b80da-d093-4987-9711-9c7eb1b42a4d",
            "faces": [
                {
                    "bounding_box": {
                        "top":428,
                        "right":247,
                        "angle":0,
                        "bottom":521,
                        "left":168
                    },
                    "id": "30ae963d-d707-4528-a5ed-f3acc21f7dd7",
                    "landmarks": {
                        "left-mouth": {
                            "y":497.80352783203125,
                            "x":192.77993774414062
                        },
                        "left-eye": {
                            "y":460.55133056640625,
                            "x":189.2744140625
                        },
                        "nose": {
                            "y":483.4483947753906,
                            "x":207.6852569580078
                        },
                        "right-mouth": {
                            "y":497.8222961425781,
                            "x":222.74261474609375
                        },
                        "right-eye": {
                            "y":460.5907287597656,
                            "x":225.84567260742188
                        }
                    }
                }
            ]
        },
        "faces": [
            [
                {
                    "applied_service":null,
                    "created_at":"2021-06-19T18:23:28.453188+00:00",
                    "score":0.9999999999999221,
                    "name":"Face 1"
                }
            ]
        ],
        "history": [
            [
                {
                    "num_suspect_faces":0,
                    "num_inquiry":1,
                    "num_member_suspect_faces":0,
                    "num_member_inquiry":1,
                    "period":"last_1day"
                },
                {
                    "num_suspect_faces":0,
                    "num_inquiry":2,
                    "num_member_suspect_faces":0,
                    "num_member_inquiry":1,
                    "period":"last_7day"
                },
                {
                    "num_suspect_faces":0,
                    "num_inquiry":3,
                    "num_member_suspect_faces":0,
                    "num_member_inquiry":1,
                    "period":"last_30day"
                },
                {
                    "num_suspect_faces":1,
                    "num_inquiry":3,
                    "num_member_suspect_faces":1,
                    "num_member_inquiry":1,
                    "period":"last_180day"
                }
            ]
        ]
    }
}

{
    "image_ids": []string,
    "collection": string,
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/delete_faces \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "image_ids": [
      "a4facba3-334b-41fb-97e3-4766cb70ae29",
      "7db00808-0416-45cf-a5cb-3b6dfbd7bb74"
    ]
}
'

{
    "data": {
        "request_id": string,
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "request_id": "d4493ff5-e41f-4d10-a291-6a9727050b4c"
    }
}

{
    "metadata": dictionary,
    "collection": string,
    "max_results": int
}

curl -X POST \
https://tv-staging.trustingsocial.com/api/v1/search_metadata \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "metadata":  {
        "national_id": "123456789"
    }
}
'

{
    "data": {
        "request_id": string,
        "status": string, // "success" or "failure"
        "faces": [ // List faces have metadata matched with the search condition
                {
                    "id": string, // id of the face in image
                    "image_id": string, // id of original image
                    "metadata": // list of meta data information of this face
                        {
                            "field": string, // "application_id": "123", "national_id": 123, ...
                            ... // other fields
                        }
                },
                ... // other face matched of metadata
            ],
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}

{
    "data": {
        "faces": [
            {
                "id": "d7e3bc6c-6562-4a6d-b6a7-c85cf69c5fae",
                "image_id": "b35acc59-eefb-44fb-a6eb-ea02cec42cfc",
                "metadata": {
                    "app_id": "5555",
                    "national_id": "6666"
                }
            }
        ],
        "request_id": "59466df0-4815-49af-9652-622861b7a511",
        "status": "success"
    }
}

{
    "metadata": dictionary,
    "label": string,
    "override": bool,
}

curl -X PATCH \
https://tv-staging.trustingsocial.com/api/v1/images/a4facba3-334b-41fb-97e3-4766cb70ae29 \
-H 'Authorization: TV <YOUR ACCESS KEY>:<CREATED SIGNATURE>' \
-H 'X-TV-Timestamp: 2019-04-21T18:00:15+07:00' \
-H 'Content-Type: application/json' \
-d \
'
{
    "metadata":  {
        "national_id": "123456789"
    }
}
'

{
    "data": {
        "image_id": string, // ID of the uploaded image in DB
        "label": string, // Label of the uploaded image
        "metadata": dictionary, // Metadata of the uploaded image
    },
    "errors": [
        {
            "code": string,
            "message": string,
            "detail": {
                "field": string, // optional, which parameter is invalid.
                ... // any other information that can be useful for client
            },
        },
        ... // other errors
    ]
}