Trust And Safety 1.1.0

/accounts

/accounts/{accountId}

/accounts/{accountId}

Create an account to use for moderation

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Content-Type

string

Define the content-type of the request payload.

Enum: application/json

Request Body

Request an account

object	object
name	string

POST /accounts

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --header 'Content-Type: {Content-Type}' \ --data '{  "name": "my demo account"}'
Copy

Responses

201

Created

object	object
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}$`

400

Bad request

401

Unauthorized

409

Duplicate account name error

422

Too many accounts created

500

Internal server error

Response

xxxxxxxxxx
 
{ "id": "{string}"}
Copy

Retrieve an account

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

account response

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Delete an account

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

204

account deleted

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Invitations

/accounts/{accountId}/invitations

/accounts/{accountId}/invitations

/accounts/{accountId}/invitations/{invitationId}

List the accounts pending invitiations

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}/invitations

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/invitations' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

invitations	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}$`
email	string
username	string
admin	boolean
expires_at	date-time
created_at	date-time

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Invite a user to the account

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 a user joins an account

object object

string

maxLength: 100

minLength: 7

admin boolean

POST /accounts/{accountId}/invitations

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/invitations' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "email": "{string}",  "admin": "{boolean}"}'
Copy

Responses

201

Created

object	object
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}$`

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "id": "{string}"}
Copy

Revoke a pending invitation

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

invitationId

string

The ID of an invitation 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}/invitations/{invitationId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/invitations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

204

Resource deleted

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Members

/accounts/{accountId}/members

/accounts/{accountId}/members/{memberId}

PUT

/accounts/{accountId}/members/{memberId}

/accounts/{accountId}/members/{memberId}

List account members

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}/members

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/members' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

members	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}$`
email	string	maxLength: 100
username	string
admin	boolean
scopes	array[string]
created_at	date-time

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Fetch account member

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

memberId

string

The ID of an member 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}/members/{memberId}

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/members/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

Resource found

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Update the scopes available to a member

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

memberId

string

The ID of an member 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

Body to be sent when modifying an account members scopes

scopes

array[string]

Enum: contents:list,contents:manage,contents:moderate,contents:view,contents:reports:list,contents:reports:moderate,flags:manage,members:manage,moderations:manage,moderations:view,notifications:manage,notifications:view,profiles:list,profiles:manage,profiles:view,reports:view,reports:manage

PUT /accounts/{accountId}/members/{memberId}

xxxxxxxxxx
 
curl --request PUT \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/members/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "scopes": [    "contents:list",    "contents:manage",    "contents:moderate",    "contents:view",    "moderations:manage",    "moderations:view",    "profiles:view",    "reports:view",    "reports:manage"  ]}'
Copy

Responses

204

Resource deleted

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Remove account member

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

memberId

string

The ID of an member 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}/members/{memberId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/members/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

204

Resource deleted

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Admin

/accounts/{accountId}/scopes

/accounts/{accountId}/admin

/accounts/{accountId}/admin/{memberId}

List available scopes

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}/scopes

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/scopes' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

List of scopes

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Upgrade account member to admin

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

Body to be sent when converting an account member into an account admin

member_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}/admin

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/admin' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "schema": "{}"}'
Copy

Responses

200

Member made admin

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Downgrade account member

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

memberId

string

The ID of an member 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}/admin/{memberId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/admin/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

204

Resource deleted

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Moderation

/accounts/{accountId}/moderations

/accounts/{accountId}/moderations

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

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

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

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

/accounts/{accountId}/moderations/{moderationId}/notifications

/accounts/{accountId}/moderations/{moderationId}/stop

Fetch a paginated list of moderation requests

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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: VIDEO,LIVE_VIDEO,IMAGE

GET /accounts/{accountId}/moderations

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data page=1 \ --data type=VIDEO
Copy

Responses

200

contents	object
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}$`
content_type	string	Enum: `IMAGE`,`VIDEO`,`LIVE_VIDEO`
url	string	pattern: `https://.*`
checks	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}$`
check_type	string	Enum: `UNKNOWN_FACE`,`AGE_ESTIMATION`,`BANNED_PROFILE`,`KNOWN_FACE`
notifications	array
destination	string	pattern: `https://*`
notification_type	string	Enum: `SLACK`,`HTTP`

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Request a resource is moderated

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

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. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

object	object
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}$`
profile_ids	array[string]
group_ids	array[string]
age_estimation	integer	Create a notification if unknown faces are outside of this age range maximum: 100 minimum: 0
unknown_faces	boolean	Create a notification for unknown faces
notifications	object
web_destinations	array[string]
slack_destinations	array[string]
member_id	string	send the results to this member's inbox 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}/moderations

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --header 'Content-Type: {Content-Type}' \ --data '{  "content_id": "{string}",  "profile_ids": [    "{array[string]...}"  ],  "group_ids": [    "{array[string]...}"  ],  "age_estimation": 18,  "unknown_faces": true,  "notifications": {    "web_destinations": "https://example.com/webhook?exampleArgument=exampleValue",    "slack_destinations": "https://hooks.slack.com/services/T0000000/B000000/XXXXXXX",    "member_id": "{string}"  }}'
Copy

Responses

201

Created

object	object
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}$`

400

Bad request

401

Unauthorized

422

Content can't be reached

500

Internal server error

Response

xxxxxxxxxx
 
{ "id": "{string}"}
Copy

Request an overview of a specific moderation request

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

content	object
id	string
type	string
url	string
uploader	object
id	string
display_name	string
reference	string
profiles	array[object]
id	string
display_name	string
reference	string
groups	array[object]
id	string
label	string

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Request the details for a specific moderation request

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/details' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

contents	object
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}$`
content_type	string	Enum: `IMAGE`,`VIDEO`,`LIVE_VIDEO`
url	string	pattern: `https://.*`
checks	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}$`
check_type	string	Enum: `UNKNOWN_FACE`,`AGE_ESTIMATION`,`BANNED_PROFILE`,`KNOWN_FACE`
notifications	array
destination	string	pattern: `https://*`
notification_type	string	Enum: `SLACK`,`HTTP`

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

DEPRECATE - Request the results of a moderation requestDeprecated

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/results' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

content_type	string	Enum: `VIDEO`,`LIVE_VIDEO`,`IMAGE`
url	string
face_check_results	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}$`
frame_time	number
is_banned	boolean
age_group	string	Enum: `threshold_met`,`not_required`,`unknown`,`child`,`teenager_young`,`teenager_old`,`adult_young`,`adult`
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}$`
face_top	integer
face_right	integer
face_bottom	integer
face_left	integer

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Request the results of a moderation request

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/report' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

banned_faces	boolean
unknown_faces	boolean
age_groups	array[string]	Enum: `threshold_met`,`not_required`,`unknown`,`child`,`teenager_young`,`teenager_old`,`adult_young`,`adult`
url	string
face_check_results	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}$`
frame_time	number
is_banned	boolean
age_group	string	Enum: `threshold_met`,`not_required`,`unknown`,`child`,`teenager_young`,`teenager_old`,`adult_young`,`adult`
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}$`
face_top	integer
face_right	integer
face_bottom	integer
face_left	integer

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Request the notifications generated for a moderation

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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

epoch

integer

starting date for a filter

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

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/notifications' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data page=1 \ --data epoch={epoch}
Copy

Responses

200

account_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	string	Enum: `FACE`,`ACTION`
created_at	date-time
data	object
moderation_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}$`
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}$`
url	string
content_type	string	Enum: `IMAGE`,`VIDEO`,`LIVE_VIDEO`
reasons	array[string]	Enum: `BANNED_PROFILE`,`AGE_ESTIMATION`,`UNKNOWN_FACE`,`STARTED`,`STOPPED`
frame_time	number
observed_at	number
top	integer
left	integer
bottom	integer
right	integer
age_group	string	Enum: `unknown`,`not_required`,`child`,`teenager_young`,`teenager_old`,`adult_young`,`adult`,`threshold_met`

400

Bad request

401

Unauthorized

404

Specified resource not found

422

Pagingation out of range

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Stop a running moderation

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}/moderations/{moderationId}/stop

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/moderations/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7/stop' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

202

accepted

No response body

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Notifications

/accounts/{accountId}/notifications

/accounts/{accountId}/notifications/{id}

/accounts/{accountId}/notifications/{id}/accept

/accounts/{accountId}/notifications/{id}/dismiss

/accounts/{accountId}/notifications/{id}/reviews

Request latest notifications

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

epoch

integer

starting date for a filter

GET /accounts/{accountId}/notifications

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/notifications' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data page=1 \ --data epoch={epoch}
Copy

Responses

200

List of notifications sorted most recent to oldest

object	object
notifications	array
account_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	string	Enum: `FACE`,`ACTION`
created_at	date-time
data	object
moderation_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}$`
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}$`
url	string
content_type	string	Enum: `IMAGE`,`VIDEO`,`LIVE_VIDEO`
reasons	array[string]	Enum: `BANNED_PROFILE`,`AGE_ESTIMATION`,`UNKNOWN_FACE`,`STARTED`,`STOPPED`
frame_time	number
observed_at	number
top	integer
left	integer
bottom	integer
right	integer
age_group	string	Enum: `unknown`,`not_required`,`child`,`teenager_young`,`teenager_old`,`adult_young`,`adult`,`threshold_met`
meta	object
total_count	integer
page	integer

Expand

400

Bad request

401

Unauthorized

404

Specified resource not found

422

Pagingation out of range

500

Internal server error

Response

xxxxxxxxxx
 
{ "notifications": [  "{array...}" ], "meta": {  "total_count": 1,  "page": 1 }}
Copy

Request a specific notification

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}/notifications/{id}

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/notifications/c32c25e2-f7e6-4cb4-879a-771730e881ed' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

account_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	string	Enum: `FACE`,`ACTION`
created_at	date-time
data	object
moderation_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}$`
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}$`
url	string
content_type	string	Enum: `IMAGE`,`VIDEO`,`LIVE_VIDEO`
reasons	array[string]	Enum: `BANNED_PROFILE`,`AGE_ESTIMATION`,`UNKNOWN_FACE`,`STARTED`,`STOPPED`
frame_time	number
observed_at	number
top	integer
left	integer
bottom	integer
right	integer
age_group	string	Enum: `unknown`,`not_required`,`child`,`teenager_young`,`teenager_old`,`adult_young`,`adult`,`threshold_met`
average_score	integer	maximum: 100 minimum: 0
total_revies	integer	minimum: 0

Expand

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Record a notification as incorrect

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}$

Request Body

Create a review for a notification

comment

string

Why the review score was given

maxLength: 500

POST /accounts/{accountId}/notifications/{id}/accept

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/notifications/c32c25e2-f7e6-4cb4-879a-771730e881ed/accept' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "schema": "{}"}'
Copy

Responses

200

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Record a notification as incorrect

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}$

Request Body

Create a review for a notification

comment

string

Why the review score was given

maxLength: 500

POST /accounts/{accountId}/notifications/{id}/dismiss

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/notifications/c32c25e2-f7e6-4cb4-879a-771730e881ed/dismiss' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "schema": "{}"}'
Copy

Responses

200

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Fetch pagingated list of reviews for a notification

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}$

Query String

page

integer

Which page of resources to fetch

minimum: 1

Default: 1

GET /accounts/{accountId}/notifications/{id}/reviews

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/notifications/c32c25e2-f7e6-4cb4-879a-771730e881ed/reviews' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data page=1
Copy

Responses

200

reviews	array
id	string	Resource identifier for this review pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
notification_id	string	Which notification does this review relate to pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
user_id	string	Who performed this review pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$`
description	string	Why the review score was given
score	integer	The score given to this review maximum: 100 minimum: 0
created_at	date-time	When was this review performed
total_count	number

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Profiles

/accounts/{accountId}/profiles

/accounts/{accountId}/profiles

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

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

/accounts/{accountId}/profiles/{profileId}/biometric-consent

/accounts/{accountId}/profiles/{profileId}/biometric-consent

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

List profiless for a given account

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}/profiles

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data page=1
Copy

Responses

200

profiles	array
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}$`
is_banned	boolean	Is the profile on the ban list Deprecated
is_active	boolean	Is the profile active, if the profile is not active it will be deleted. Further actions will not be possible with this profile Deprecated
active	boolean	Is the profile active, if the profile is not active it will be deleted. Further actions will not be possible with this profile

400

Bad request

401

Unauthorized

404

Specified resource not found

422

Pagingation out of range

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Create a profile that can contain a collection of faces

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

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. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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	The type of profile to be created 1 searchable profiles 2 non-searchable profiles Enum: `1`,`2`
display_name	string	How should this profile be named in a platform, for visual representation to a human
reference	string	A reference string used to identify the profile in a consistent manner, assuming the display_name may change over time
biometric_consent	string	A reference string used to identify when consent for biometric processing was obtained for the profile
consent_link	string	A reference of the consent the user has given for the video pattern: `https?://*`
id_verification	string	A reference of the ID verification that can be linked to the profile
is_id_verified	boolean	A flag that says if the ID was verified
face	string	base64 encoding png or jpeg of the individuals face (one face only)

POST /accounts/{accountId}/profiles

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --header 'Content-Type: {Content-Type}' \ --data '{  "schema": "{}"}'
Copy

Responses

201

Created

object	object
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}$`

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "id": "{string}"}
Copy

Fetch a profile's details

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
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}$`
is_banned	boolean	Is the profile on the ban list Deprecated
is_active	boolean	Is the profile active, if the profile is not active it will be deleted. Further actions will not be possible with this profile Deprecated
active	boolean	Is the profile active, if the profile is not active it will be deleted. Further actions will not be possible with this profile

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Delete a profile and all faces

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}/profiles/{profileId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

202

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Extend the lifecycle of a profileDeprecated

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

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. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}/profiles/{profileId}/retain

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/retain' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --header 'Content-Type: {Content-Type}'
Copy

Responses

202

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Faces

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

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

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

Get faces in profile

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

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. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/faces' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --header 'Content-Type: {Content-Type}'
Copy

Responses

200

No response body

400

Bad request

401

Unauthorized

404

Profile has been archived

410

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Add a face to profile

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

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. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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

object	object
image	string	base64 encoding png or jpeg of the individuals face (one face only)

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/faces' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --header 'Content-Type: {Content-Type}' \ --data '{  "image": "{string}"}'
Copy

Responses

201

Created

object	object
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}$`

400

Bad request

401

Unauthorized

404

Profile has been archived

410

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "id": "{string}"}
Copy

Delete a face from the profile

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}$

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/profiles/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/faces/c32c25e2-f7e6-4cb4-879a-771730e881ed' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

202

No response body

401

Unauthorized

404

Profile has been archived

410

Specified resource not found

422

Must be between 1 - 10 faces per profile

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Groups

/accounts/{accountId}/groups

/accounts/{accountId}/groups

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

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

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

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

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

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

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

Get a list of Groups

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

object	object
groups	array[object]
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

422

Pagingation out of range

500

Internal server error

Response

xxxxxxxxxx
 
{ "groups": [  {   "id": "{string}",   "label": "abuse"  } ]}
Copy

Create a group to collect profiles

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

Name and description of group

object object

label

string

maxLength: 50

minLength: 1

POST /accounts/{accountId}/groups

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "label": "ban_00001"}'
Copy

Responses

201

Created

object	object
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}$`

400

Bad request

401

Unauthorized

409

Reference already used

422

Too many groups created

500

Internal server error

Response

xxxxxxxxxx
 
{ "id": "{string}"}
Copy

Get a group

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

object	object
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

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "id": "{string}", "label": "{string}"}
Copy

Add a profile to a group

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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

object	object
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}

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "profile_id": "{string}"}'
Copy

Responses

201

Created

object	object
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}$`

400

Bad request

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
{ "id": "{string}"}
Copy

Deletes a group

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

204

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Check if a face exists in a group

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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

Check if an image is in a group

image

string

base64 encoding png or jpeg of the challenge object

liveness_level_of_assurance

string

Level of assurance to use when performing liveness

Enum: low,medium,high

is_mobile

boolean

Was the image captured from a mobile device (required if liveness_level_of_assurance is provided)

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/challenge' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "schema": "{}"}'
Copy

Responses

200

profile_id

string

The id of the matched profile

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

422

No face found in image

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Get historical face checks against a group

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}/challenges

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/challenges' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data page=1
Copy

Responses

200

checks	array[object]
transaction_id	string
group_id	string
profile_id	string
date	string
total	number

400

Bad request

401

Unauthorized

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Retrieve all profiles in a group

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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}/profiles

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/groups/9a4534a3-a4c1-4a09-ade0-e1d9d457b40d/profiles' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

object	object
profiles	array
id	string	The of the matched profile. Empty if nothing is found 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	A reference that links back to why this profile was added to the group.
display_name	string	a descriptive name for the profile

400

Bad request

401

Unauthorized

404

Specified resource not found

422

Pagingation out of range

500

Internal server error

Response

xxxxxxxxxx
 
{ "profiles": [  "{array...}" ]}
Copy

Remove a profile from a group

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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 subject to query or modification

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 subject to query or modification

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}

xxxxxxxxxx
 
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 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Policies

/accounts/{accountId}/policies

/accounts/{accountId}/policies

/accounts/{accountId}/policies/{policyId}

/accounts/{accountId}/policies/{policyId}

/accounts/{accountId}/policies/{policyId}/tags

/accounts/{accountId}/policies/{policyId}/version

/accounts/{accountId}/policies/{policyId}/version/{version}

Get a list of policies

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

policy

string

The type of policies to the returned

Enum: true,false,all

GET /accounts/{accountId}/policies

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/policies' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data page=1 \ --data policy={policy}
Copy

Responses

200

policies	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}$`
version_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}$`
version	number
name	string
data	string
type	string
tags	array[string]
is_public	boolean

401

Unauthorized

422

Pagingation out of range

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Create a policy for an account

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

Required data for a policy

object	object
name	string	minLength: 1
data	string	minLength: 1
type	string	Enum: `DOCUMENT`,`LINK`
tags	array[string]
is_public	boolean

POST /accounts/{accountId}/policies

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/policies' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "name": "{string}",  "data": "{string}",  "type": "{string}",  "tags": [    "{array[string]...}"  ],  "is_public": "{boolean}"}'
Copy

Responses

201

Created

object	object
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}$`

400

Bad request

401

Unauthorized

409

Reference already used

500

Internal server error

Response

xxxxxxxxxx
 
{ "id": "{string}"}
Copy

Get policy details

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

policyId

string

The Id of a policy 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}/policies/{policyId}

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/policies/e0c9708c-1c61-4b52-8dc2-1dec42429480' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

policy	object
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}$`
version_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}$`
version	number
name	string
data	string
type	string
tags	array[string]
is_public	boolean

401

Unauthorized

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Delete a policy

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

policyId

string

The Id of a policy 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}/policies/{policyId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/policies/e0c9708c-1c61-4b52-8dc2-1dec42429480' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

204

Policy deleted

No response body

400

Bad request

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Tag a policy

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

policyId

string

The Id of a policy 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

Request to tag a policy

object	object
tags	array[string]

POST /accounts/{accountId}/policies/{policyId}/tags

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/policies/e0c9708c-1c61-4b52-8dc2-1dec42429480/tags' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "tags": [    "{array[string]...}"  ]}'
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}$`
version	string

401

Unauthorized

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Tag a policy

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

policyId

string

The Id of a policy 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

Request to update a policy

object	object
name	string	minLength: 1
data	string
type	string	Enum: `DOCUMENT`,`LINK`
tags	array[string]

POST /accounts/{accountId}/policies/{policyId}/version

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/policies/e0c9708c-1c61-4b52-8dc2-1dec42429480/version' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "name": "{string}",  "data": "{string}",  "type": "{string}",  "tags": [    "{array[string]...}"  ]}'
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}$`
version	string

401

Unauthorized

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Get policy details for a specific version

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

policyId

string

The Id of a policy 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}$

version

integer

The number of the policy version

minimum: 1

GET /accounts/{accountId}/policies/{policyId}/version/{version}

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/policies/e0c9708c-1c61-4b52-8dc2-1dec42429480/version/1' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

200

policy	object
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}$`
version_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}$`
version	number
name	string
data	string
type	string
tags	array[string]
is_public	boolean

401

Unauthorized

500

Internal server error

Response

xxxxxxxxxx
 
{ "schema": "{}"}
Copy

Websocket

/accounts/{accountId}/sockets/connect

/accounts/{accountId}/sockets/listen

/accounts/{accountId}/sockets/mute

/accounts/{accountId}/sockets/unmute

Open a websocket connection

Auth

Headers

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}/sockets/connect

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/sockets/connect' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

101

Upgrade response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Authenticate a websocket connection

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Yoti-Connection-Id

string

Websocket Connection ID, used to identify a connection

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}/sockets/listen

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/sockets/listen' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --header 'Yoti-Connection-Id: ca8125f4-8f9e-38cf-b002-fe2e09feb5a2'
Copy

Responses

202

Websocket connection authenticated

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Hold websocket connection open, but stop receiving messages

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Yoti-Connection-Id

string

Websocket Connection ID, used to identify a connection

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}/sockets/mute

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/sockets/mute' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --header 'Yoti-Connection-Id: ca8125f4-8f9e-38cf-b002-fe2e09feb5a2'
Copy

Responses

202

Websocket connection will no longer recieve messages

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Begin recieving messages again

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Yoti-Connection-Id

string

Websocket Connection ID, used to identify a connection

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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}/sockets/unmute

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/sockets/unmute' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --header 'Yoti-Connection-Id: ca8125f4-8f9e-38cf-b002-fe2e09feb5a2'
Copy

Responses

202

Websocket connection will begin recieving messages

No response body

401

Unauthorized

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Flags

/accounts/{accountId}/flags

/accounts/{accountId}/flags

/accounts/{accountId}/flags/{reasonId}

Retrieve a list of report reasons

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

type

string

The type of content to filter by

Enum: VIDEO,LIVE_VIDEO,IMAGE

GET /accounts/{accountId}/flags

xxxxxxxxxx
 
curl --get \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/flags' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data type=VIDEO
Copy

Responses

200

array array

string

The id used to identify the report reason

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

reason string

400

Bad request

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
[ "{array...}"]
Copy

Create a reason for receiving reports

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

Body to be sent when defining a reason a report is acceptable

reason	string	maxLength: 500
content_type	string	Enum: `VIDEO`,`IMAGE`,`LIVE_VIDEO`

POST /accounts/{accountId}/flags

xxxxxxxxxx
 
curl --request POST \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/flags' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3' \ --data '{  "schema": "{}"}'
Copy

Responses

201

Created report

No response body

400

Bad request

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Deactivate a report reason

Auth

Headers

Authorization

string

Authorization token

Yoti-Sdk-Id

string

Relying party's App ID

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

Path Params

accountId

string

The account ID you are operating under. One SDK ID may support multiple account IDs e.g. a test account, production account etc.

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

reasonId

string

The ID of a report reason 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}/flags/{reasonId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://trust-and-safety.yoti.com/accounts/e0c9708c-1c61-4b52-8dc2-1dec42429480/flags/fd93da66-b9c1-4a7c-8719-de5bb9ceb7f7' \ --header 'Authorization: {Authorization}' \ --header 'Yoti-Sdk-Id: e8468a54-a655-47ed-92d5-ef00dcba0ac3'
Copy

Responses

204

Report deleted

No response body

400

Bad request

404

Specified resource not found

500

Internal server error

Response

xxxxxxxxxx
 
No response
Copy

Content Report

/accounts/{accountId}/reports

/accounts/{accountId}/reports/{date}/{dayRange}

/accounts/{accountId}/reports/{id}/dismiss