Getting started
Core resources
Other

Digital Identity

Field descriptions

{
  "id": { "type": "string" }, // (Required) Unique identifier for the data
  "document_type": { "type": "string" }, // (Required) Must be "none"
  "credential_type": { "type": "string" }, // (Required) Must be "digital_identity"
  "data": { // { "type": "object" }, (Required)
    "credential": { // { "type": "object" }, (Required)
      "full_name": { "type": "string" }, // (Required)
      "identity_verification_level": { "type": "string" }, // (Required) Must be one of "basic" or "standard"
    },
    "partner_chain": { "type": ["array", "null"] } // (Optional unless otherwise specified) Array of objects to specifiy partner institutions, e.g. [{ "name": "Partner Organization" }]
  }
}

Leveraging Digital Identity fields

Partner chain

The partner_chain field captures intermediate relationships in multi-layered partner hierarchies that aren't represented elsewhere in the integration. It improves the granularity of analytics SEEK Pass can provide to you.Click here for more details.

Sample payload

{
  "id": "fa651300-b91a-49cb-8ee7-cac68b3fdf74",
  "document_type": "none",
  "credential_type": "digital_identity",
  "data": {
    "credential": {
      "full_name": "John Doe",
      "identity_verification_level": "basic"
    }
  }
}