Skip to main content

Conference Interview Methods

This set of API calls should be used only by the bank executive. For that purpose tokens with special permissions are needed.
Most of the results from the customer side API calls are not returned back but are rather visible from interviewer side.

Start

Method: GET

API Endpoint:

/omni/queue/conference/next

Description:

Fetch next customer in the conference queue. Fields 'interviewToken' and 'sessionId' are connection parameters for OpenTok conference. In case no customer in the queue, and empty body is returned.

  • Request

    • Headers
    Content-Type:application/json
    api-version:1.0
    X-Incode-Hardware-Id:eyJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiI1YWM0ZTg0MWM1MWZkZDI388ZjAzZjk3ODIiLCJuYW1lIjoiRXJpY2sgQ2FtYWNobyIsInJvbGUiOiJBQ0NFU1MiLCJleHAiOjE1MjgxMTE0NjQsImlhdCI6MTUyMjkyNzQ2NH0.tsFu4FUqp9fG_ZjYKinjGQMj5KWe0PskiZDstE-o4k857
    x-api-key: <client-specific-key>
  • Response 200 (application/json)

        {
    "interviewId": <string> (optional if there is no customer in queue),
    "interviewToken": <string> (optional if there is no customer in queue),
    "sessionId": <string> (optional if there is no customer in queue)
    }

Read Queue

Method: GET

API Endpoint:

/omni/queue/conference?queueName=diogenes

Description:

Fetch waiting users in the queue.

  • Request (application/json)

    • Headers
    Content-Type:application/json
    api-version:1.0
    X-Incode-Hardware-Id:eyJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiI1YWM0ZTg0MWM1MWZkZDI388ZjAzZjk3ODIiLCJuYW1lIjoiRXJpY2sgQ2FtYWNobyIsInJvbGUiOiJBQ0NFU1MiLCJleHAiOjE1MjgxMTE0NjQsImlhdCI6MTUyMjkyNzQ2NH0.tsFu4FUqp9fG_ZjYKinjGQMj5KWe0PskiZDstE-o4k857
    x-api-key:<client-specific-key>
  • Response 200 (application/json)

        {
    "queue":
    [
    "5b8fb1d09c6b79001002c1e7",
    "5b8fd8d19c6b79001002c1ee",
    "5b8fb4489c6b79001002c1e8",
    ...
    ]
    }

Get User Data

Method: GET

API Endpoint:

/omni/get/data?id=4390u032r

Description:

Returns data about user. Parameter id is optional.

  • Request (application/json)

    • Headers
    Content-Type:application/json
    api-version:1.0
    X-Incode-Hardware-Id:ACCESS_TOKEN
    x-api-key:<client-specific-key>
  • Response 200 (application/json)

    {
    "_id": "5e0b133d8c00860016e7e8db",
    "_createdAt": 1577784125675,
    "_updatedAt": 1577784125675,
    "apiKey": "f35844c8bcb417be1a64fd6e8d622cc93b0fcfaa",
    "name": "DIEGO MONDRAGON OCARANZA",
    "phone": "+381605211222",
    "birthDate": "632966400000",
    "address": "COL PEDREGAL DE SAN ANGEL 01900\nALVARO OBREGON ,D.F.",
    "gender": "M",
    "typeOfId": "INE",
    "countryCode": "MEX",
    "cic": "114988030",
    "numeroEmisionCredencial": "01",
    "acuantId": "aaee4760-8e4a-40ee-9c74-4973471ee736",
    "tamperedConfidence": 0.17613846,
    "idValidationScore": "Attention",
    "fakeIdConfidence": 0.9999198,
    "paperFrontConfidence": 0.0,
    "screenFrontConfidence": 1.7501973e-6,
    "paperBackConfidence": 0.0,
    "screenBackConfidence": 3.5412256e-7,
    "retouchFrontConfidence": 0.004690816,
    "classification": 14,
    "frontSharpness": 59,
    "frontGlare": 100,
    "frontShadowConfidence": 0.8312062,
    "backSharpness": 67,
    "backGlare": 100,
    "backShadowConfidence": 0.6933477,
    "issueDate": 2014,
    "expirationDate": 2024,
    "croppedIDFaceRef": "5e0b26528c00860016e7e8fa",
    "fullFrameFrontIDRef": "5e0b26528c00860016e7e8fb",
    "fullFrameBackIDRef": "5e0b26dc8cdb170011c6e705",
    "frontIdProcessed": true,
    "backIdProcessed": true,
    "idValidationFinished": true,
    "paternalLastNameValid": true,
    "maternalLastNameValid": false,
    "nameValid": true,
    "curpValid": true,
    "ocrValid": true,
    "claveDeElectorValid": true,
    "numeroEmisionCredencialValid": true,
    "registrationDateValid": true,
    "issueDateValid": true
    }