Trust And Safety Public API 1.0.0

Server

https://trust-and-safety.yoti.com

Production Environment

Authentication

Relying party's App ID (UUID)

Fields

Key	In
Yoti-Sdk-Id	Header

http BearerAuth

Bearer token from Yoti Hub

Account

POST

/accounts

GET

/accounts/{accountId}

Create an account

Auth

Headers

Content-Type

string

Define the content-type of the request payload.

Enum: application/json

Request Body

Create an account

name string

POST /accounts

 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts' \ --header 'Content-Type: {Content-Type}' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{  "schema": "{}"}'
Copy

Responses

201

Created

string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

400

Bad request

401

Unauthorized

409

Duplicate account name error

422

Too many accounts created

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Fetch an account

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
name	string
organisation_id	string
type	integer
account_class	integer
is_active	boolean

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Profiles

GET

/accounts/{accountId}/profiles

POST

/accounts/{accountId}/profiles

GET

/accounts/{accountId}/profiles/{profileId}

List profiles

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Query String

page	integer	Which page of resources to fetch minimum: 1 Default: 1
type	integer	Filter by profile type
search	string	Search term to filter profiles maxLength: 50
idv	string	Filter by ID verification status Enum: `PRESENT`,`ANY`,`MISSING` Default: ANY
groupId	string	Filter by group ID

GET /accounts/{accountId}/profiles

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data page=1 \ --data type={type} \ --data search={search} \ --data idv=ANY \ --data groupId={groupId}
Copy

Responses

200

profiles	array
is_active	boolean
profile_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
reference	string
display_name	string
consent_link	string
id_verification	string
is_id_verified	boolean
total_count	integer

401

Unauthorized

403

Forbidden

422

Bad request

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Create a profile

Auth

Headers

Content-Type

string

Define the content-type of the request payload.

Enum: application/json

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request Body

Create a profile

profile_type	number	Enum: `1`,`2`,`3`
display_name	string
reference	string
biometric_consent	string
consent_link	string	pattern: `https?://*`
id_verification	string
is_id_verified	boolean
face	string

POST /accounts/{accountId}/profiles

 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles' \ --header 'Content-Type: {Content-Type}' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{  "schema": "{}"}'
Copy

Responses

201

id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
genesis_face_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
display_name	string
reference	string

400

Bad request

401

Unauthorized

415

Unsupported media type

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Fetch a profile's details

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

profileId

string

The ID of the profile resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/profiles/{profileId}

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
is_banned	boolean
is_active	boolean
reference	string
biometric_consent	string
has_biometric_consent	boolean
display_name	string
groups	array
group_id	string
label	string
consent_link	string
id_verification	string
is_id_verified	boolean
profile_type	integer
hidden	boolean

401

Unauthorized

403

Forbidden

404

Specified resource not found

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Faces

POST

/accounts/{accountId}/profiles/{profileId}/faces

GET

/accounts/{accountId}/profiles/{profileId}/faces/{faceId}

Add a face to profile

Auth

Headers

Content-Type

string

Define the content-type of the request payload.

Enum: application/json

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

profileId

string

The ID of the profile resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request Body

Payload of a face to add

image	string	base64 encoding png or jpeg of the individuals face (one face only)
captured_at	int64	Unix timestamp of when the face was captured

POST /accounts/{accountId}/profiles/{profileId}/faces

 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/faces' \ --header 'Content-Type: {Content-Type}' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{  "schema": "{}"}'
Copy

Responses

201

Created

string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

400

Bad request

401

Unauthorized

404

Specified resource not found

409

Resource already exists

415

Unsupported media type

422

No face found in image

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Get face in profile

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

profileId

string

The ID of the profile resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

faceId

string

The ID of the face resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/profiles/{profileId}/faces/{faceId}

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/faces/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

image

string

minLength: 1

401

Unauthorized

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

GET

/accounts/{accountId}/contents

POST

/accounts/{accountId}/contents

GET

/accounts/{accountId}/contents/{id}

List contents

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Query String

page	integer	Which page of resources to fetch minimum: 1 Default: 1
type	string	The type of content to filter by Enum: `ADVERT`,`IMAGE`,`LIVE_VIDEO`,`VIDEO`,`WEBSITE`,`PROFILE`,`TEXT`
profileId	string	Filter by profile ID
archive	string	Include archived contents Enum: `true`,`false`

GET /accounts/{accountId}/contents

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/contents' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data page=1 \ --data type={type} \ --data profileId={profileId} \ --data archive={archive}
Copy

Responses

200

contents	array
id	string
title	string
type	string
url	string
archived	boolean
created_at	string
public_url	string
public_id	string
id	string
display_name	string
reference	string
hidden	boolean
total_count	integer

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Create a record of a content

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request Body

Create a content record

url	string	pattern: `https?://*`
type	string	Enum: `ADVERT`,`IMAGE`,`LIVE_VIDEO`,`VIDEO`,`WEBSITE`,`PROFILE`,`TEXT`
profile_ids	array[string]
uploader_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
title	string	maxLength: 200 minLength: 0

POST /accounts/{accountId}/contents

 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/contents' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{  "schema": "{}"}'
Copy

Responses

201

Created

string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

400

Bad request

401

Unauthorized

402

Account limit exceeded

403

Forbidden

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Fetch content

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

string

The ID of a resource to operate on

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/contents/{id}

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/contents/c32c25e2-f7e6-4cb4-879a-771730e881ed' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

id	string
title	string
url	string
content_type	string
archived	boolean
created_at	string
public_id	string
public_url	string
id	string
display_name	string
reference	string
hidden	boolean
profiles	array
id	string
is_banned	boolean
is_active	boolean
reference	string
display_name	string
groups	array
group_id	string
label	string
hidden	boolean
documents	array
id	string
note	string
name	string
description	string
tags	array[string]

401

Unauthorized

403

Forbidden

404

Specified resource not found

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Groups

POST

/accounts/{accountId}/groups

GET

/accounts/{accountId}/groups

GET

/accounts/{accountId}/groups/{groupId}

POST

/accounts/{accountId}/groups/{groupId}

GET

/accounts/{accountId}/groups/{groupId}/profiles

DELETE

/accounts/{accountId}/groups/{groupId}/profiles/{profileId}

POST

/accounts/{accountId}/groups/{groupId}/facesearch

GET

/accounts/{accountId}/groups/{groupId}/facesearch

Create a group to collect profiles

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request Body

Create a group

label

string

maxLength: 50

minLength: 1

POST /accounts/{accountId}/groups

 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{  "schema": "{}"}'
Copy

Responses

201

Created

string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

400

Bad request

401

Unauthorized

403

Forbidden

409

Reference already used

422

Too many groups created

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Fetch groups

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/groups

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

groups	array
id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
label	string

401

Unauthorized

403

Forbidden

404

Specified resource not found

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Fetch group details

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

groupId

string

The ID of the group resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/groups/{groupId}

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
label	string

401

Unauthorized

403

Forbidden

404

Specified resource not found

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Add a profile to a group

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

groupId

string

The ID of the group resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request Body

Add a profile to a group

profile_id

string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

POST /accounts/{accountId}/groups/{groupId}

 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{  "schema": "{}"}'
Copy

Responses

201

group_profiles_count integer

400

Bad request

401

Unauthorized

403

Forbidden

404

Specified resource not found

409

Resource already exists

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Fetch profiles in a group

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

groupId

string

The ID of the group resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Query String

page	integer	Which page of resources to fetch minimum: 1 Default: 1
type	integer	Filter by profile type
search	string	Search term to filter profiles maxLength: 50
idv	string	Filter by ID verification status Enum: `PRESENT`,`ANY`,`MISSING` Default: ANY

GET /accounts/{accountId}/groups/{groupId}/profiles

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/profiles' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data page=1 \ --data type={type} \ --data search={search} \ --data idv=ANY
Copy

Responses

200

profiles	array
id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
type	integer
date_of_birth	string
is_banned	boolean
is_active	boolean
reference	string
display_name	string
consent_link	string
id_verification	string
is_id_verified	boolean
group_ids	array[string]
age_verification_status	string

401

Unauthorized

403

Forbidden

404

Specified resource not found

422

Bad request

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Remove a profile from a group

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

profileId

string

The ID of the profile resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

groupId

string

The ID of the group resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

DELETE /accounts/{accountId}/groups/{groupId}/profiles/{profileId}

 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

204

No Content

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

 
No response
Copy

Search for a face in a group

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

groupId

string

The ID of the group resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request Body

Search for a face in a group

image	string	base64 encoding png or jpeg of the face image
liveness_level_of_assurance	string	Enum: `low`,`medium`,`high`
is_mobile	boolean
is_laptop	boolean
sicap_version	string
secure_token	string
signature	string
verification	string

POST /accounts/{accountId}/groups/{groupId}/facesearch

 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/facesearch' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{  "schema": "{}"}'
Copy

Responses

200

profile_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
transaction_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
tamper_report	string
liveness_prediction	string
match_score	number

400

Bad request

401

Unauthorized

403

Forbidden

404

Specified resource not found

422

No face found in image

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Get historical face search results for a group

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

groupId

string

The ID of the group resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Query String

page

integer

Which page of resources to fetch

minimum: 1

Default: 1

GET /accounts/{accountId}/groups/{groupId}/facesearch

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/facesearch' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data page=1
Copy

Responses

200

results	array
transaction_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
group_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
profile_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
date	date-time
match_score	number
sicap_version	string
tamper_report	string
liveness_level_of_assurance	string
liveness_prediction	string
total	integer

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Moderation

GET

/accounts/{accountId}/moderations

POST

/accounts/{accountId}/moderations

GET

/accounts/{accountId}/moderations/{moderationId}/results

GET

/accounts/{accountId}/moderations/{moderationId}/details

GET

/accounts/{accountId}/moderations/{moderationId}/report

Fetch paged moderations

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Query String

page	integer	Which page of resources to fetch minimum: 1 Default: 1
type	string	The type of content to filter by
memberId	string	Filter by assigned member
status	string	Filter by moderation status

GET /accounts/{accountId}/moderations

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data page=1 \ --data type={type} \ --data memberId={memberId} \ --data status={status}
Copy

Responses

200

moderation_details	array
id	string
id	string
display_name	string
reference	string
hidden	boolean
id	string
type	string
url	string
title	string
public_id	string
public_url	string
created_at	string
manual	string
automated	string
status	string
assigned_to	string
total_count	integer

401

Unauthorized

403

Forbidden

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Request a resource is moderated

Auth

Headers

Content-Type

string

Define the content-type of the request payload.

Enum: application/json

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request Body

Request moderation job

content_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
moderator_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
profile_ids	array[string]
group_ids	array[string]
age_estimation	integer	maximum: 100 minimum: 0
unknown_faces	boolean
consent	boolean
id_verified_profiles	boolean
id_verified_uploader	boolean
web_destination	string
slack_destination	string
flagged_object_categories	array[string]
flagged_contexts	array[string]
policies	array
policy_id	string
policy_version_id	string
user_info	string
query	string

POST /accounts/{accountId}/moderations

 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations' \ --header 'Content-Type: {Content-Type}' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{  "schema": "{}"}'
Copy

Responses

202

Created

string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

400

Bad request

401

Unauthorized

402

Account limit exceeded

403

Forbidden

404

Specified resource not found

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Request the results of a moderation request

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

moderationId

string

The ID of the moderation resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/moderations/{moderationId}/results

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/results' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

content_type	string	Enum: `ADVERT`,`IMAGE`,`LIVE_VIDEO`,`VIDEO`,`WEBSITE`,`PROFILE`,`TEXT`
url	string
face_check_results	array
frame_time	number
face_top	integer
face_right	integer
face_bottom	integer
face_left	integer
age_group	string
profile_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
profile_document_check_results	array
has_supplied_consent	boolean
has_supplied_identity	boolean
consent_document	string
identity_document	string
profile_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
has_supplied_consent	boolean
has_supplied_identity	boolean
consent_document	string
identity_document	string
profile_id	string	pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
counters	object

400

Bad request

401

Unauthorized

403

Forbidden

404

Specified resource not found

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Fetch moderation details

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

moderationId

string

The ID of the moderation resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/moderations/{moderationId}/details

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/details' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

id	string
content_type	string
url	string
id	string
web_destination	string
slack_destination	string
checks	array
id	string
check_type	string
assigned_to	string
policies	array
id	string
policy_id	string
policy_version_id	string
check_type	string
content_type	string
can_override	boolean
age_estimation	integer
unknown_faces	boolean
consent	boolean
id_verified_profiles	boolean
id_verified_uploader	boolean
group_ids	array[string]
flagged_object_categories	array[string]
flagged_contexts	array[string]

401

Unauthorized

403

Forbidden

404

Specified resource not found

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Request the report of a moderation request

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

moderationId

string

The ID of the moderation resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/moderations/{moderationId}/report

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/report' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

requested_checks	array
type	string
warnings	boolean
processing_state	string
manual_reviews	array
review_id	string
member_id	string
username	string
decision	string
reviewed_at	string
objects_check_results	array
object_label	string
object_category	string
contexts_check_results	array
context_label	string

401

Unauthorized

500

Internal server error

Response

 
{ "schema": "{}"}
Copy

Appeal

POST

/accounts/{accountId}/appeals

GET

/accounts/{accountId}/appeals/{appealId}

PUT

/accounts/{accountId}/appeals/{appealId}/status

GET

/accounts/{accountId}/appeals/{appealId}/evidence

GET

/accounts/{accountId}/appeals/{appealId}/activity

GET

/accounts/{accountId}/appeals/{appealId}/comments

Create an appeal

Auth

Headers

Content-Type

string

Define the content-type of the request payload.

Enum: application/json

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request Body

object object

POST /accounts/{accountId}/appeals

 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/appeals' \ --header 'Content-Type: {Content-Type}' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

Appeal created

No response body

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

 
No response
Copy

Fetch an appeal

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

appealId

string

The ID of the appeal resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/appeals/{appealId}

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/appeals/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Appeal details

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

 
No response
Copy

Update appeal status

Auth

Headers

Content-Type

string

Define the content-type of the request payload.

Enum: application/json

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

appealId

string

The ID of the appeal resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request Body

object object

PUT /accounts/{accountId}/appeals/{appealId}/status

 
curl --request PUT \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/appeals/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/status' \ --header 'Content-Type: {Content-Type}' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

Status updated

No response body

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

 
No response
Copy

List appeal evidence

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

appealId

string

The ID of the appeal resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/appeals/{appealId}/evidence

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/appeals/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/evidence' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Evidence list

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

 
No response
Copy

List appeal activity

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

appealId

string

The ID of the appeal resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/appeals/{appealId}/activity

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/appeals/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/activity' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Activity list

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

 
No response
Copy

List appeal comments

Auth

Path Params

accountId

string

The account id you are operating under.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

appealId

string

The ID of the appeal resource

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

GET /accounts/{accountId}/appeals/{appealId}/comments

 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/appeals/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/comments' \ --header 'Yoti-Sdk-Id: {Yoti-Sdk-Id}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Comments list

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

 
No response
Copy

Trust And Safety Public API 1.0.0

Authentication

Account

Create an account

Fetch an account

Profiles

List profiles

Create a profile

Fetch a profile's details

Faces

Add a face to profile

Get face in profile

Contents

List contents

Create a record of a content

Fetch content

Groups

Create a group to collect profiles

Fetch groups

Fetch group details

Add a profile to a group

Fetch profiles in a group

Remove a profile from a group

Search for a face in a group

Get historical face search results for a group

Moderation

Fetch paged moderations

Request a resource is moderated

Request the results of a moderation request

Fetch moderation details

Request the report of a moderation request

Appeal

Create an appeal

Fetch an appeal

Update appeal status

List appeal evidence

List appeal activity

List appeal comments