---
title: "JSON Model"
slug: "json-model"
updated: 2024-10-07T07:50:26Z
published: 2024-10-07T07:50:26Z
canonical: "docs.onespan.com/json-model"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onespan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# JSON Model

The OneSpan Identity Verification REST API is based on resources defined in the OneSpan Identity Verification [Transaction model](/v1/docs/transaction-model). This model is fully specified by the JSON schemas that are described in these articles. All OneSpan Identity Verification JSON models are defined based on the JSON schema draft-04 specification.

For the JSON schema definition, refer to [https://www.ietf.org/archive/id/draft-zyp-json-schema-04.txt](https://www.ietf.org/archive/id/draft-zyp-json-schema-04.txt)

## Example

```json
{
  "workflow_id": "80b601c9-f102-4761-9eaa-90ba8fcb58b6",
  "urlSetKey":"default",
  "language": "english",
  "opaque_id": "WorkflowExternalMitAtPwd=1234",
  "brand_id": "a089f718-f12d-4b13-b82e-e1d8b324337d",
  "configuration": {
    "redirects": [
      {
        "id": "REDIRECT_DOCID_PASS",
        "url": "https://www.overriddenUrl.com/?user={{userRole}}&transaction={{transactionId}}&opaqueId={{opaqueId}}"
      }
    ]
  },
  "users":[{
    "groups": ["visible"],
    "first_name": "John",
    "middle_name": "",
    "last_name": "Doe",
    "title": "Mr.",
    "role": "signer1",
    "dob": "2013-07-01T00:00:00.000Z",
    "phone_number": "+15550111",
    "address":{
      "country_code":"CA",
      "county_or_province": "Quebec",
      "city":"Montreal",
      "town": "MyTown",
      "street": "MyStreet",
      "house_name": "MyHouse",
      "house_number": "123",
      "flat_or_appartment_number": "456",
      "po_box": "MyPObox",
      "post_code": "MyPostCode"
    },
    "company": "MyCompany"
  }],
  "tokens": [{
    "role": "signer1"
  }],
  "documents": [{
    "id": "ee02adab-4946-4fae-884f-d8990aaf776a",
    "document_template_id": "babdf419-6144-4e01-b8fb-98c863c9a2f2"
  }]
}
```