Reference for all sandbox test data returned by the deepidv API when using a sandbox API key. See Sandbox Mode for setup instructions.
How Sandbox Responses Work
When you make aGET request with a sandbox API key, the API returns pre-built test data instead of querying real records. The response shape is identical to production — the only difference is that the data is synthetic.
Non-GET requests (POST, PATCH, PUT, DELETE) return a 403 error:
Sessions
Retrieve Session — GET /v1/sessions/:id
Use well-known test IDs to control the scenario. Any unrecognized ID returns a random scenario.
test_verified — Full “everything” response
Returns a VERIFIED session with every possible field populated. Use this to validate your integration handles the complete response shape.
Key fields included:
type: "session"(workflow-based)workflow_id,workflow_steps(all 11 steps)bank_statement_request_idlocation,submitted_at,meta_data- Full
uploads(primary, secondary, and tertiary IDs, selfies, custom prompt) - Complete
analysis_datawith all sub-objects user(applicant profile) andsender_user(session creator profile)
test_rejected
Returns a REJECTED session with basic analysis data — failing face match and ID checks. When the rejection came from AI auto-decline, meta_data.declinedData records the decisive reason:
declinedData for the full field reference.
test_submitted
Returns a SUBMITTED session with basic analysis data — passing scores, awaiting manual review.
test_pending
Returns a PENDING session with no analysis data and session_progress: "PENDING".
test_voided
Returns a VOIDED session with no analysis data.
test_failed
Returns a FAILED session — a session that was auto-failed after reaching the workflow’s configured number of failed attempts. session_progress is COMPLETED and meta_data.failureData is populated with the recorded attempts:
failureData for the full field reference.
List Sessions — GET /v1/sessions
Returns 5 sessions (one per status) with lightweight analysis data. The list uses basic analysis — the full “everything” payload is only returned when fetching test_verified by ID.
Financial
Retrieve Bank Statement — GET /v1/financial/:id
test_completed
Returns a completed bank statement with full statement data including accounts, transactions, and holder info.
Sensitive fields (
TransitNumber, InstitutionNumber) are omitted from sandbox responses, matching production behavior.test_pending
Returns a pending bank statement with no statement field.
List Bank Statements — GET /v1/financial
Returns 2 bank statements (completed and pending) without the statement body — matching production list behavior.
Credit Checks
Retrieve Credit Check — GET /v1/credit-checks/:id
Credit checks come in two types: soft and hard. Soft checks return only the credit score. Hard checks include the full AI-powered credit insights analysis.
The Credit Checks API is coming soon. Sandbox mode lets you preview the response shape before the live API is available.
test_soft_pass — Soft credit check
Returns a soft credit check with score only — no detailed insights.
test_hard_pass — Hard credit check (low risk)
Returns a hard credit check with a clean credit profile and full AI insights.
test_hard_review — Hard credit check (medium risk)
Returns a hard credit check with late payments, high utilization, and a paid collection — flagged for manual review.
test_hard_high_risk — Hard credit check (high risk)
Returns a hard credit check with active consumer proposal, unpaid collections, and a fraud alert.
List Credit Checks — GET /v1/credit-checks
Returns all 4 credit check scenarios:
Credit Insights Fields
Workflows
Retrieve Workflow — GET /v1/workflows/:id
test_workflow — Full workflow
Returns a workflow with all 11 available steps, each with realistic config objects:
Any other ID — Basic workflow
Returns a workflow with 2 steps:id-verification and face-liveness.