Retrieve Results

The response will detail all information, check and task completion status, resource and media data, along with the associated media identifiers.

Sessions can be retrieved at any time, however the integrating backend will be notified when a session update occurs, according to the notifications settings provided at session creation.

const { RequestBuilder, Payload } = require("yoti");

const request = new RequestBuilder()

.withBaseUrl("https://api.yoti.com/sandbox/idverify/v1")

.withPemFilePath("<YOTI_KEY_FILE_PATH>")

.withEndpoint(`/sessions/<SESSION_ID>`)

.withMethod("GET")

.withQueryParam("sdkId", "<YOTI_CLIENT_SDK_ID>")

.build();

//get Yoti response

const response = request.execute();

<?php

use Yoti\Http\RequestBuilder;

use Yoti\Http\Payload;

$request = (new RequestBuilder())

->withBaseUrl('https://api.yoti.com/sandbox/idverify/v1')

->withPemFilePath('<YOTI_KEY_FILE_PATH>')

->withEndpoint('/sessions/<SESSION_ID>')

->withMethod('GET')

->withQueryParam('sdkId', '<YOTI_CLIENT_SDK_ID>')

->build()

//get Yoti Response

->execute();

from yoti_python_sdk.http import SignedRequest, RequestHandler

import json

import requests

def execute(request):

response = requests.request(

url=request.url, data=request.data, headers=request.headers, method=request.method)

return response.content

def get_session():

signed_request = (

SignedRequest

.builder()

.with_pem_file("<YOTI_KEY_FILE_PATH>")

.with_base_url("https://api.yoti.com/sandbox/idverify/v1")

.with_endpoint("/sessions/<SESSION_ID>")

.with_http_method("GET")

.with_param("sdkId", "<YOTI_CLIENT_SDK_ID>")

.build()

)

response = signed_request.execute()

response_payload = json.loads(response.text)

byte[] payload = ...

try {

SignedRequest signedRequest = SignedRequestBuilder.newInstance()

.withKeyPair(<YOTI_KEY_FILE_PATH>)

.withBaseUrl("https://api.yoti.com/sandbox/idverify/v1")

.withEndpoint("/sessions/<SESSION_ID>")

.withHttpMethod("GET")

.withQueryParameter("sdkId", "<YOTI_CLIENT_SDK_ID>")

.build();

YourPojo yourPojo = signedRequest.execute(YourPojo.class);

} catch (GeneralSecurityException | URISyntaxException | IOException | ResourceException ex) {

ex.printStackTrace();

}

import (

"io/ioutil"

"net/http"

"github.com/getyoti/yoti-go-sdk/v2/requests"

)

sdkID := "<YOTI_CLIENT_SDK_ID>";

key, _ := ioutil.ReadFile("<YOTI_KEY_FILE_PATH>")

// Create session

sessionRequest, _ := requests.SignedRequest{

HTTPMethod: http.MethodGet,

BaseURL: "https://api.yoti.com/sandbox/idverify/v1",

Endpoint: "/sessions/<SESSION_ID>",

Params: map[string]string{

"sdkId": sdkID,

Headers: map[string][]string{

"Content-Type": {"application/json"},

"Accept": {"application/json"},

}.WithPemFile(key).Request()

//get Yoti response

sessionResponse, _ := http.DefaultClient.Do(sessionRequest)

using System;

using System.IO;

using System.Net.Http;

using System.Text;

using Microsoft.AspNetCore.Mvc;

using Yoti.Auth.Web;

HttpClient httpClient = new HttpClient();

StreamReader privateKeyStream = System.IO.File.OpenText("PEM_FILE_PATH");

Uri _baseUrl = new UriBuilder("https", "api.yoti.com", 443, "sandbox/idverify/v1").Uri;

Yoti.Auth.Web.Request ageScanRequest = new RequestBuilder()

.WithStreamReader(privateKeyStream)

.WithBaseUri(_baseUrl)

.WithEndpoint("/sessions/<SESSION_ID>")

.WithHttpMethod(HttpMethod.Get)

.WithQueryParam("sdkId", "YOUR_SDK_ID")

.Build();

HttpResponseMessage response = ageScanRequest.Execute(httpClient).Result;

See below for an example response from the retrieve session endpoint.

Session Response

{…}

Retrieve Media

A second API call will need to be made to retrieve the media related to a session e.g document images. The media is linked to the image will need to be added in the API request.

const { RequestBuilder} = require("yoti");

const request = new RequestBuilder()

.withBaseUrl("https://api.yoti.com/idverify/v1")

.withPemFilePath("<YOTI_KEY_FILE_PATH>") // file path to PEM file

.withEndpoint("/sessions/<sessionId>/media/<mediaId>/content")

.withMethod("GET")

.withQueryParam("sdkId", "<YOTI_CLIENT_SDK_ID>")

.build();

//get Yoti response

const response = await request.execute();

<?php

require_once './vendor/autoload.php';

use Yoti\Http\RequestBuilder;

$response = (new RequestBuilder())

->withBaseUrl('https://api.yoti.com/idverify/v1')

->withPemFilePath('<YOTI_KEY_FILE_PATH>')

->withEndpoint('/sessions/<sessionId>/media/<mediaId>/content')

->withMethod('GET')

->withQueryParam('sdkId', '<YOTI_CLIENT_SDK_ID>')

->build()

->execute();

//get Yoti response

$result = $response->getBody();

from yoti_python_sdk.http import SignedRequest, RequestHandler

import json

import requests

def execute(request):

response = requests.request(

url=request.url, data=request.data, headers=request.headers, method=request.method)

return response.content

def get_session():

signed_request = (

SignedRequest

.builder()

.with_pem_file("<YOTI_KEY_FILE_PATH>")

.with_base_url("https://api.yoti.com/idverify/v1")

.with_endpoint("/sessions/<sessionId>/media/<mediaId>/content")

.with_http_method("GET")

.with_param("sdkId", "<YOTI_CLIENT_SDK_ID>")

.build()

)

response = signed_request.execute()

try {

SignedRequest signedRequest = SignedRequestBuilder.newInstance()

.withKeyPair(<YOTI_KEY_FILE_PATH>)

.withBaseUrl("https://api.yoti.com/idverify/v1")

.withEndpoint("/sessions/<SESSION_ID>/media/<mediaId>/content")

.withHttpMethod("GET")

.withQueryParameter("sdkId", "<YOTI_CLIENT_SDK_ID>")

.build();

YourPojo yourPojo = signedRequest.execute(YourPojo.class);

} catch (GeneralSecurityException | URISyntaxException | IOException | ResourceException ex) {

ex.printStackTrace();

}

import (

"io/ioutil"

"net/http"

"github.com/getyoti/yoti-go-sdk/v2/requests"

)

sdkID := "<YOTI_CLIENT_SDK_ID>";

key, _ := ioutil.ReadFile("<YOTI_KEY_FILE_PATH>")

// Create session

sessionRequest, _ := requests.SignedRequest{

HTTPMethod: http.MethodGet,

BaseURL: "https://api.yoti.com/idverify/v1",

Endpoint: "/sessions/<SESSION_ID>/media/<mediaId>/content",

Params: map[string]string{

"sdkId": sdkID,

Headers: map[string][]string{

"Content-Type": {"application/json"},

"Accept": {"application/json"},

}.WithPemFile(key).Request()

//get Yoti response

sessionResponse, _ := http.DefaultClient.Do(sessionRequest)

using System;

using System.IO;

using System.Net.Http;

using System.Text;

using Microsoft.AspNetCore.Mvc;

using Yoti.Auth.Web;

HttpClient httpClient = new HttpClient();

StreamReader privateKeyStream = System.IO.File.OpenText("PEM_FILE_PATH");

Uri _baseUrl = new UriBuilder("https", "api.yoti.com", 443, "sandbox/idverify/v1").Uri;

Yoti.Auth.Web.Request ageScanRequest = new RequestBuilder()

.WithStreamReader(privateKeyStream)

.WithBaseUri(_baseUrl)

.WithEndpoint("/sessions/<SESSION_ID>/media/<MEDIA_ID>/content")

.WithHttpMethod(HttpMethod.Get)

.WithQueryParam("sdkId", "YOUR_SDK_ID")

.Build();

HttpResponseMessage response = ageScanRequest.Execute(httpClient).Result;

Last updated on

Was this page helpful?