IDP Sandbox

AI Tools

The Yoti Identity Profiles (IDP) Sandbox is an isolated testing environment for validating your integration with mock data and simulated verification outcomes.

What you can do

  • Test end-to-end flows without real user data
  • Simulate different verification outcomes (approvals, rejections, extractions)
  • Use standard Yoti backed SDKs (no separate sandbox SDK)
  • Manually test using the user view, or automate testing (via built-in agent) by bypassing the user view.

Key differences

Sandbox uses the same SDKs as production but requires:

  • Sandbox URL: https://api.yoti.com/sandbox/idverify/v1
  • Sandbox keys from Yoti Hub
  • Predefined successful responses by default
  • Optional response configuration

Ensure you have submitted your Yoti Hub organisation for verification and have generated sandbox keys.

Sandbox keys

Install the SDK

Install the Yoti SDK using your language's package manager. The same SDK is used for both production and sandbox environments.

Node.js
Java
PHP
Python
C#
Go
Copy

Step 1: Initialise the client

Initialise the Yoti client with your sandbox credentials and point it to the sandbox URL.

Sandbox URL: https://api.yoti.com/sandbox/idverify/v1

Node.js
Java
PHP
C#
Go
Copy

Step 2: Create a session

Create an identity verification session exactly as you would in production. The session configuration determines what identity profile scheme is used.

Node.js
Java
PHP
C#
Go
Copy

More details on how to create a session can be found here

Trust FrameworkScheme TypeObjectiveDescription
UK_TFIDARTWN/AUK certified right to work verification.
UK_TFIDARTRN/AUK certified right to rent verification.
UK_TFIDADBSBASIC, STANDARD, ENHANCEDUK certified digital method for verifying a person's identity for criminal record checks
YOTI_GLOBALIDENTITYAL_L1, AL_M1Yoti created Identity verification that can be set to a low assurance "L1" or a medium assurance "M1". The medium assurance adds a biometric face match.
YOTI_GLOBALIDENTITY_PLUS_ADDRESSAL_L1, AL_M1Yoti created Identity verification that can be set to a low assurance "L1" or a medium assurance "M1". The medium assurance adds a biometric face match. An address check will also be performed.
YOTI_GLOBALGBR_RTW_SHARECODEN/AYoti created verification that will fetch a users share code details and compare them to details extracted from a users Id documents.
YOTI_GLOBALCAN_CRCN/AYoti created Identity verification that will verify a document and perform a biometric face match. For the Canadian Criminal Record Check.

Step 3a: Launch the user view (manual testing)

Construct the following URL for manual testing, and render it inside an iFrame:

HTTP
Copy

iFrame example

HTML
Copy

Users can upload sample documents and selfies, and the sandbox returns predefined successful responses along with the uploaded image resources.

Step 3b: Use the agent endpoint (automated testing)

The /agent endpoint bypasses the user view and completes sessions programmatically with sample data—ideal for CI/CD and automated tests.

Endpoint

HTTP
Copy
Use CaseBenefit
Automated testsSkip manual document upload
CI/CD pipelinesIntegrate verification in build process

Payload structure

JSON
Copy

Code examples

Node.js
Java
PHP
C#
Go
Copy

Step 4: Retrieve session results

After the session is completed (either via user view or agent endpoint), retrieve the results to verify the outcome.

Node.js
Java
PHP
C#
Go
Copy

More details on how to retrieve the results can be found here

Example sandbox response

Here is a sample JSON response from a finished sandbox session:

JSON
Copy

Default responses

The sandbox automatically provides approved results for the checks using sample data which will result in an overall pass, for the configured scheme. for example:

  • Document authenticity: APPROVE
  • Liveness: APPROVE
  • Face match: APPROVE
  • Third party identity: APPROVE
  • Fraud check: APPORVE
  • DBS scheme: REQUIREMENTS MET
  • Resources: Sample images and text extraction (Document fields)

This lets you test result handling without configuration.

Step 5: (Optional) Configure custom responses

To simulate failures or custom scenarios, refer to the sandbox Configure response guide. This lets you provide mock data such as for text extraction and also simulate partial check approvals or rejections.

You can use the same production SDKs for this as well.

Troubleshooting

Session not completing? Verify you're using the sandbox URL: https://api.yoti.com/sandbox/idverify/v1

Authentication errors? Ensure you're using sandbox keys (not production) and haven't opened the PEM file manually.

Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard