Common · Standard API · eKYC Core

Get result

GET/v1/requests_by_req_id/{request_id}

Looks up a request by the request_id returned from a previous API call and returns that service's own response.

Request

MethodGET
Path/v1/requests_by_req_id/{request_id}
Content-Typeapplication/json
Auth requiredYes — HMAC signing

Where request_id is the ID of the request returned in previous API call.

Sample request

curl -X GET \
https://tv-staging.trustingsocial.com/api/v1/requests_by_req_id/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'

Response

What comes back is the response of the service that handled the request, so the shape follows whichever endpoint created it.

Service nameResponse
Read ID card infoCheck the response section read_id_card_info
Verify face livenessCheck the response section verify_face_liveness
Verify face video livenessCheck the response section verify_face_video_liveness
Verify portrait sanityCheck the response section verify_portrait_sanity
Compare facesCheck the response section compare_faces
Search facesCheck the response section search_faces
Verify ID cardCheck the response section verify_id_card_sanity
ID Card tamperingCheck the response section detect_id_card_tampering
Detect ID cardsCheck the response section detect_id_cards

A request created by verify_face_liveness comes back like this:

JSON
{
    "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",
        "service": "verify_face_liveness",
        "score": 0.9999999862517992,
        "status": "success",
        "videos": [
            {
                "is_live": true,
                "score": 1
            }
        ]
    }
}