{
  "openapi": "3.1.0",
  "info": {
    "title": "Signicat Verify API",
    "version": "1.0.9",
    "description": "API for managing identity proofing templates, profiles, sessions, step results, and evidence.",
    "contact": "",
    "license": "",
    "termsOfService": ""
  },
  "servers": [
    {
      "url": "https://api.signicat.com/id-proofing/verify"
    }
  ],
  "tags": [
    {
      "name": "public"
    }
  ],
  "paths": {
    "/sessions/token": {
      "post": {
        "summary": "Create session",
        "description": "This endpoint creates an identity-proofing session for your predefined [profile](https://developer.signicat.com/docs/verify/about/#profiles) and returns a `sessionId` and an `sdkToken`. <br /><br />**Next steps**:\n- Your backend system must pass the `sdkToken` and `sessionId` to your mobile application’s client SDK to initialise the identity proofing flow for the end-user.\n- After the end-user has finished the identity proofing session, you use the `sessionId` to retrieve the results and evidence.",
        "operationId": "createSessionToken",
        "tags": [
          "public"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "examples": {
                "Native session": {
                  "value": {
                    "profileId": "11111111-1111-1111-1111-111111111111",
                    "platform": "native",
                    "reference": "order-12345"
                  }
                }
              },
              "schema": {
                "$ref": "#/components/schemas/CreateSessionTokenRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Session token created",
            "content": {
              "application/json": {
                "examples": {
                  "Session token": {
                    "value": {
                      "sessionId": "22222222-2222-2222-2222-222222222222",
                      "sdkToken": "eyJhbGciOi..."
                    }
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/SessionTokenResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid or missing required input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized. Requires OAuth2 bearer token with appropriate scope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. Requires OAuth2 bearer token with appropriate scope and Verify product access.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "404": {
            "description": "Profile not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          }
        }
      }
    },
    "/sessions/{sessionId}": {
      "get": {
        "summary": "Get session",
        "description": "Returns the current session state and, when available, normalized identity data, checks, and evidence metadata. Poll this endpoint while the session is in progress. Results can be absent until the relevant step or session has completed. Requires an OAuth2 bearer token for the account that owns the session.",
        "operationId": "getSession",
        "tags": [
          "public"
        ],
        "parameters": [
          {
            "description": "Session identifier.",
            "example": "00000000-0000-0000-0000-000000000000",
            "required": true,
            "name": "sessionId",
            "in": "path",
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Session returned",
            "content": {
              "application/json": {
                "examples": {
                  "Completed session": {
                    "value": {
                      "metadata": {
                        "id": "22222222-2222-2222-2222-222222222222",
                        "platform": "native",
                        "reference": "order-12345",
                        "status": "COMPLETED",
                        "templateName": "Identity verification",
                        "profileId": "11111111-1111-1111-1111-111111111111",
                        "profileName": "Standard",
                        "sessionSteps": [
                          {
                            "index": 0,
                            "sessionStepId": "document-read",
                            "stepConfigurationId": "44444444-4444-4444-4444-444444444444",
                            "displayName": "Read identity document",
                            "stepName": "document-read",
                            "stepType": "SDK",
                            "status": "SUCCEEDED",
                            "createdAt": "2026-10-01T10:00:00Z",
                            "updatedAt": "2026-10-01T10:01:00Z"
                          }
                        ],
                        "createdAt": "2026-10-01T10:00:00Z",
                        "updatedAt": "2026-10-01T10:02:00Z"
                      },
                      "aggregatedIdentity": {},
                      "evidenceFiles": []
                    }
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/SessionResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized. Requires OAuth2 bearer token with appropriate scope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. Requires OAuth2 bearer token with appropriate scope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "404": {
            "description": "Session not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Delete session",
        "description": "Permanently deletes a session and all of its data, including its archived evidence files. This operation is irreversible; retrieve any evidence you must retain before deleting. Requires OAuth2 bearer token with appropriate scope.",
        "operationId": "deleteSession",
        "tags": [
          "public"
        ],
        "parameters": [
          {
            "description": "Session identifier.",
            "example": "00000000-0000-0000-0000-000000000000",
            "required": true,
            "name": "sessionId",
            "in": "path",
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Session deleted"
          },
          "401": {
            "description": "Unauthorized. Requires OAuth2 bearer token with appropriate scope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. Requires OAuth2 bearer token with appropriate scope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "404": {
            "description": "Session not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          }
        }
      }
    },
    "/sessions/{sessionId}/session-steps/{sessionStepId}": {
      "get": {
        "summary": "Get session step result",
        "description": "Returns the result for one session step. Obtain sessionStepId from the session metadata. An account bearer token can read its account's steps; the SDK token returned when creating the same session can also read it. Identity, checks, and evidence are included only when produced by the step.",
        "operationId": "getSessionStepResult",
        "tags": [
          "public"
        ],
        "parameters": [
          {
            "description": "Identifier of the owning session.",
            "example": "22222222-2222-2222-2222-222222222222",
            "required": true,
            "name": "sessionId",
            "in": "path",
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          },
          {
            "description": "Step identifier from metadata.sessionSteps[].sessionStepId.",
            "example": "document-read",
            "required": true,
            "name": "sessionStepId",
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Session step result returned",
            "content": {
              "application/json": {
                "examples": {
                  "Completed step": {
                    "value": {
                      "metadata": {
                        "sessionStepId": "document-read",
                        "index": 0,
                        "displayName": "Read identity document",
                        "stepName": "document-read",
                        "status": "COMPLETED"
                      },
                      "evidenceFiles": []
                    }
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/SessionStepResultResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid bearer token"
          },
          "403": {
            "description": "SDK token belongs to a different session"
          },
          "404": {
            "description": "Session or session step not found"
          }
        }
      }
    },
    "/sessions/{sessionId}/session-steps/{sessionStepId}/result/raw": {
      "get": {
        "summary": "Get raw session step result",
        "description": "Returns the provider payload recorded for a session step. This is provider-specific data with no stable schema; use the normalized step result when available. Returns an empty object when the step has no raw payload. Requires an OAuth2 bearer token for the account that owns the session; SDK tokens cannot access this endpoint.",
        "operationId": "getRawSessionStepResult",
        "tags": [
          "public"
        ],
        "parameters": [
          {
            "description": "Identifier of the owning session.",
            "example": "22222222-2222-2222-2222-222222222222",
            "required": true,
            "name": "sessionId",
            "in": "path",
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          },
          {
            "description": "Step identifier from metadata.sessionSteps[].sessionStepId.",
            "example": "document-read",
            "required": true,
            "name": "sessionStepId",
            "in": "path",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Raw provider result returned",
            "content": {
              "application/json": {
                "examples": {
                  "Provider-specific payload": {
                    "value": {
                      "providerReference": "example-reference",
                      "decision": "approved"
                    }
                  }
                },
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Missing or invalid bearer token"
          },
          "403": {
            "description": "An SDK token cannot access raw results"
          },
          "404": {
            "description": "Session or session step not found"
          }
        }
      }
    },
    "/sessions/{sessionId}/evidence-files": {
      "get": {
        "summary": "List session evidence",
        "description": "Lists the evidence files stored for a session. Use each id with the download endpoint. The list contains metadata only and does not download any file. After the session is finalized the list also includes the SESSION_RESULT and SESSION_PLAN evidences produced by Verify, each once its write has succeeded; a failed write is retried, so either can be missing for a while. Requires an OAuth2 bearer token for the account that owns the session.",
        "operationId": "getSessionEvidenceFiles",
        "tags": [
          "public"
        ],
        "parameters": [
          {
            "description": "Session identifier.",
            "example": "00000000-0000-0000-0000-000000000000",
            "required": true,
            "name": "sessionId",
            "in": "path",
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Evidence returned",
            "content": {
              "application/json": {
                "examples": {
                  "Evidence files": {
                    "value": [
                      {
                        "id": "33333333-3333-3333-3333-333333333333",
                        "evidenceType": "document",
                        "contentType": "application/pdf",
                        "fileName": "identity-document.pdf",
                        "description": "Identity document",
                        "source": "provider"
                      }
                    ]
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EvidenceResponse"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized. Requires OAuth2 bearer token with appropriate scope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. Requires OAuth2 bearer token with appropriate scope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "404": {
            "description": "Session not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          }
        }
      }
    },
    "/sessions/{sessionId}/evidence-files/{evidenceId}": {
      "get": {
        "summary": "Download evidence file",
        "description": "Returns the binary content of an evidence file belonging to a session. Each successful download is metered and the file can only be downloaded a limited number of times. Save the response using its Content-Type and Content-Disposition headers; do not attempt to parse it as JSON. Requires an OAuth2 bearer token for the account that owns the session.",
        "operationId": "downloadEvidenceFile",
        "tags": [
          "public"
        ],
        "parameters": [
          {
            "description": "Evidence identifier.",
            "example": "00000000-0000-0000-0000-000000000000",
            "required": true,
            "name": "evidenceId",
            "in": "path",
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          },
          {
            "description": "Session identifier.",
            "example": "00000000-0000-0000-0000-000000000000",
            "required": true,
            "name": "sessionId",
            "in": "path",
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Evidence file returned",
            "content": {
              "application/octet-stream": {
                "examples": {
                  "Binary evidence": {
                    "value": "Binary file content"
                  }
                },
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized. Requires OAuth2 bearer token with appropriate scope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. Requires OAuth2 bearer token with appropriate scope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "404": {
            "description": "No such evidence in this session for the authenticated account",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          },
          "429": {
            "description": "The maximum number of downloads for this evidence file has been reached",
            "headers": {
              "Retry-After": {
                "description": "Seconds until the download allowance resets.",
                "schema": {
                  "type": "integer"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetailResponse"
                }
              }
            }
          }
        }
      }
    },
    "/web-view-steps/{sessionStepId}/start": {
      "get": {
        "summary": "Start an ExternalWebView Session Step",
        "description": "Loaded by the SDK webview with the session token from POST /sessions/token as bearer. Verifies the step belongs to that session, issues a random completion nonce in a cookie and redirects to the configured startUrl with startParams resolved server-side from the session and from the results of earlier steps, appended as query parameters. Any query parameters the client sends are ignored.",
        "operationId": "startWebViewStep",
        "tags": [
          "public"
        ],
        "parameters": [
          {
            "name": "sessionStepId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "302": {
            "description": "Redirect to the customer startUrl",
            "headers": {
              "Location": {
                "description": "startUrl with startParams and the completion links appended"
              },
              "Set-Cookie": {
                "description": "verify-web-view-step cookie scoped to the public API base path plus /web-view-steps"
              }
            }
          },
          "401": {
            "description": "Missing or invalid session bearer token",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Session or ExternalWebView step not found, or step does not belong to the authenticated session",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "409": {
            "description": "Session is final, step is not PENDING or STARTED, an earlier step has not finished, or a startParam has no value from the session or an earlier step",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/web-view-steps/complete/{outcome}": {
      "get": {
        "summary": "Complete an ExternalWebView Session Step",
        "description": "Navigated to by the customer page through the verifySucceededUrl or verifyFailedUrl link that the start redirect handed it. Requires the temporary nonce cookie issued by the start endpoint together with the proof query parameter carried by that link. Checks server-side expiry, moves the step to SUCCEEDED or FAILED when accepted, and redirects to the configured continuationUri with sessionStepId and the current status for authenticated attempts. Invalid credentials return 401 without redirecting or clearing the cookie. The SDK reads the authoritative status from Verify.",
        "operationId": "completeWebViewStep",
        "tags": [
          "public"
        ],
        "parameters": [
          {
            "name": "outcome",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Completion Proof carried by the verifySucceededUrl or verifyFailedUrl link.",
            "required": true,
            "name": "proof",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Step identifier carried by the completion link.",
            "required": true,
            "name": "sessionStepId",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Cookie set by the start endpoint, holding the temporary completion nonce.",
            "required": true,
            "name": "verify-web-view-step",
            "in": "cookie",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "302": {
            "description": "Return to the SDK for an authenticated completion attempt; clears the cookie",
            "headers": {
              "Location": {
                "description": "Configured continuationUri with sessionStepId and status"
              },
              "Set-Cookie": {
                "description": "verify-web-view-step cookie cleared"
              }
            }
          },
          "401": {
            "description": "Missing, invalid, or expired nonce, or invalid proof; cookie is preserved",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "404": {
            "description": "Missing, malformed, or unknown ExternalWebView step identifier",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AggregatedDocumentResponse": {
        "type": "object",
        "properties": {
          "documentNumber": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "mrz": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "documentType": {
            "$ref": "#/components/schemas/SourcedDocumentTypeValueResponse"
          },
          "documentCode": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "issuingCountry": {
            "$ref": "#/components/schemas/SourcedCountryCodeValueResponse"
          },
          "issuingAuthority": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "dateOfIssue": {
            "$ref": "#/components/schemas/SourcedDateValueResponse"
          },
          "dateOfExpiry": {
            "$ref": "#/components/schemas/SourcedDateValueResponse"
          }
        }
      },
      "AggregatedIdentityResponse": {
        "type": "object",
        "properties": {
          "personalDetails": {
            "$ref": "#/components/schemas/PersonalDetailsResponse"
          },
          "biometricScores": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/SourcedNumberValueResponse"
            }
          },
          "contactAndAddress": {
            "$ref": "#/components/schemas/ContactAndAddressResponse"
          },
          "document": {
            "$ref": "#/components/schemas/AggregatedDocumentResponse"
          }
        }
      },
      "ConformanceRequest": {
        "required": [
          "standard"
        ],
        "type": "object",
        "properties": {
          "standard": {
            "type": "string",
            "maxLength": 100,
            "description": "Standard the flow conforms to. Uppercase letters, digits and _ only.",
            "examples": [
              "ETSI_TS_119_461_V2_1_1"
            ],
            "pattern": "\\S"
          },
          "level": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 100,
            "description": "Nullable. Level of the standard. Uppercase letters, digits and _ only.",
            "examples": [
              "EXTENDED"
            ]
          }
        }
      },
      "ConformanceResponse": {
        "type": "object",
        "required": [
          "standard"
        ],
        "properties": {
          "standard": {
            "type": "string",
            "description": "Standard the flow conforms to.",
            "examples": [
              "ETSI_TS_119_461_V2_1_1"
            ]
          },
          "level": {
            "type": [
              "string",
              "null"
            ],
            "description": "Nullable. Omitted when the standard has no level.",
            "examples": [
              "EXTENDED"
            ]
          }
        }
      },
      "ContactAndAddressResponse": {
        "type": "object",
        "properties": {
          "fullAddress": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "addressStreet": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "addressHouseNumber": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "addressCity": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "addressPostalCode": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "addressState": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "addressCountry": {
            "$ref": "#/components/schemas/SourcedCountryCodeValueResponse"
          },
          "email": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "phoneNumber": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          }
        }
      },
      "CreateSessionTokenRequest": {
        "required": [
          "profileId",
          "platform"
        ],
        "description": "Creates a session from a configured profile.",
        "type": "object",
        "properties": {
          "profileId": {
            "$ref": "#/components/schemas/UUID",
            "description": "The unique identifier of your organisation's predefined [profile](https://developer.signicat.com/docs/verify/about/#profiles) received from Signicat during onboarding.",
            "type": "string",
            "examples": [
              "11111111-1111-1111-1111-111111111111"
            ]
          },
          "platform": {
            "$ref": "#/components/schemas/SessionPlatform",
            "description": "The client platform that runs the identity-proofing flow, either `native` (mobile app) or `web`. <br /> <br /> **Note**: Currently, we only support `native`.",
            "type": "string",
            "examples": [
              "native"
            ]
          },
          "reference": {
            "type": "string",
            "description": "This value is returned in the response under `metadata.reference`.",
            "examples": [
              "order-12345"
            ]
          },
          "startParams": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            },
            "description": "Optional values for external web-view start parameters, keyed by the templateStepId that declares them."
          }
        }
      },
      "DecisionPolicyRequest": {
        "required": [
          "routes"
        ],
        "type": "object",
        "properties": {
          "routes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StepConditionRequest"
            },
            "description": "Ordered routes, each a condition over the steps of the session. At most 100 routes.",
            "maxItems": 100
          }
        }
      },
      "DecisionPolicyResponse": {
        "type": "object",
        "required": [
          "routes"
        ],
        "properties": {
          "routes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StepConditionResponse"
            },
            "description": "Ordered routes, each a condition over the steps of the session."
          }
        }
      },
      "DecisionReasonCode": {
        "type": "string",
        "enum": [
          "RULES_PASSED",
          "RULES_FAILED",
          "NO_ROUTE_MATCHED",
          "ALL_ROUTES_RULED_OUT",
          "SESSION_NOT_SUCCEEDED"
        ]
      },
      "DocumentType": {
        "type": "string",
        "enum": [
          "PASSPORT",
          "NATIONAL_ID",
          "DRIVING_LICENSE",
          "RESIDENCE_PERMIT",
          "WALLET"
        ]
      },
      "EvidenceRequest": {
        "type": "object",
        "required": [
          "id",
          "evidenceType",
          "contentType",
          "fileName",
          "description"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/UUID"
          },
          "evidenceType": {
            "type": "string",
            "pattern": "\\S"
          },
          "contentType": {
            "type": "string",
            "pattern": "\\S"
          },
          "fileName": {
            "type": "string",
            "pattern": "\\S"
          },
          "description": {
            "type": "string",
            "pattern": "\\S"
          }
        }
      },
      "EvidenceResponse": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/UUID",
            "description": "Evidence identifier used in the evidence download path.",
            "type": "string",
            "examples": [
              "33333333-3333-3333-3333-333333333333"
            ]
          },
          "evidenceType": {
            "type": "string",
            "description": "Category assigned to the evidence file.",
            "examples": [
              "document"
            ]
          },
          "contentType": {
            "type": "string",
            "description": "MIME type of the downloadable content.",
            "examples": [
              "application/pdf"
            ]
          },
          "fileName": {
            "type": "string",
            "description": "Suggested filename supplied with the download.",
            "examples": [
              "identity-document.pdf"
            ]
          },
          "description": {
            "type": "string",
            "description": "Optional human-readable description of the evidence.",
            "examples": [
              "Identity document"
            ]
          },
          "source": {
            "type": "string",
            "description": "System or provider that supplied the evidence.",
            "examples": [
              "provider"
            ]
          }
        }
      },
      "FailedEvidenceListResponse": {
        "required": [
          "failedEvidences"
        ],
        "type": "object",
        "properties": {
          "failedEvidences": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FailedEvidenceResponse"
            }
          },
          "page": {
            "type": "integer",
            "format": "int32"
          },
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "hasNextPage": {
            "type": "boolean"
          }
        }
      },
      "FailedEvidenceResponse": {
        "type": "object",
        "required": [
          "evidenceId",
          "sessionId",
          "reason",
          "failedAt"
        ],
        "properties": {
          "evidenceId": {
            "$ref": "#/components/schemas/UUID"
          },
          "sessionId": {
            "$ref": "#/components/schemas/UUID"
          },
          "reason": {
            "type": "string"
          },
          "failedAt": {
            "$ref": "#/components/schemas/OffsetDateTime"
          }
        }
      },
      "FailedRuleResponse": {
        "type": "object",
        "required": [
          "ruleSet",
          "rule",
          "sessionStepId"
        ],
        "properties": {
          "ruleSet": {
            "type": "string",
            "readOnly": true
          },
          "rule": {
            "type": "string",
            "readOnly": true
          },
          "sessionStepId": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "Gender": {
        "type": "string",
        "enum": [
          "M",
          "F",
          "X",
          "U"
        ]
      },
      "IdentityContactAndAddressResponse": {
        "type": "object",
        "properties": {
          "fullAddress": {
            "type": "string"
          },
          "addressStreet": {
            "type": "string"
          },
          "addressHouseNumber": {
            "type": "string"
          },
          "addressCity": {
            "type": "string"
          },
          "addressPostalCode": {
            "type": "string"
          },
          "addressState": {
            "type": "string"
          },
          "addressCountry": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string"
          }
        }
      },
      "IdentityDocumentResponse": {
        "type": "object",
        "properties": {
          "documentNumber": {
            "type": "string"
          },
          "mrz": {
            "type": "string"
          },
          "documentType": {
            "$ref": "#/components/schemas/DocumentType"
          },
          "documentCode": {
            "type": "string"
          },
          "issuingCountry": {
            "type": "string"
          },
          "issuingAuthority": {
            "type": "string"
          },
          "dateOfIssue": {
            "$ref": "#/components/schemas/LocalDate"
          },
          "dateOfExpiry": {
            "$ref": "#/components/schemas/LocalDate"
          }
        }
      },
      "IdentityPersonalDetailsResponse": {
        "type": "object",
        "properties": {
          "familyName": {
            "type": "string"
          },
          "givenNames": {
            "type": "string"
          },
          "birthFamilyName": {
            "type": "string"
          },
          "birthGivenNames": {
            "type": "string"
          },
          "dateOfBirth": {
            "$ref": "#/components/schemas/LocalDate"
          },
          "placeOfBirth": {
            "type": "string"
          },
          "nationality": {
            "type": "string"
          },
          "gender": {
            "$ref": "#/components/schemas/Gender"
          },
          "nin": {
            "type": "string"
          },
          "ageOver18": {
            "type": "boolean"
          },
          "ageOver21": {
            "type": "boolean"
          }
        }
      },
      "IdentityResponse": {
        "type": "object",
        "properties": {
          "personalDetails": {
            "description": "Nullable. Omitted when no personal-details values were provided.",
            "type": [
              "object",
              "null"
            ],
            "anyOf": [
              {
                "$ref": "#/components/schemas/IdentityPersonalDetailsResponse"
              },
              {
                "type": "null"
              }
            ]
          },
          "contactAndAddress": {
            "description": "Nullable. Omitted when no contact-and-address values were provided.",
            "type": [
              "object",
              "null"
            ],
            "anyOf": [
              {
                "$ref": "#/components/schemas/IdentityContactAndAddressResponse"
              },
              {
                "type": "null"
              }
            ]
          },
          "document": {
            "description": "Nullable. Omitted when no document values were provided.",
            "type": [
              "object",
              "null"
            ],
            "anyOf": [
              {
                "$ref": "#/components/schemas/IdentityDocumentResponse"
              },
              {
                "type": "null"
              }
            ]
          },
          "biometricScores": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": {
              "type": "number",
              "format": "double"
            },
            "description": "Nullable. Omitted when no biometric scores were provided."
          }
        }
      },
      "Instant": {
        "type": "string",
        "format": "date-time",
        "examples": [
          "2022-03-10T16:15:50Z"
        ]
      },
      "LocalDate": {
        "type": "string",
        "format": "date",
        "examples": [
          "2022-03-10"
        ]
      },
      "OffsetDateTime": {
        "type": "string",
        "format": "date-time",
        "examples": [
          "2022-03-10T12:15:50-04:00"
        ]
      },
      "PersonalDetailsResponse": {
        "type": "object",
        "properties": {
          "familyName": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "givenNames": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "birthFamilyName": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "birthGivenNames": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "dateOfBirth": {
            "$ref": "#/components/schemas/SourcedDateValueResponse"
          },
          "placeOfBirth": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "nationality": {
            "$ref": "#/components/schemas/SourcedCountryCodeValueResponse"
          },
          "gender": {
            "$ref": "#/components/schemas/SourcedGenderValueResponse"
          },
          "nin": {
            "$ref": "#/components/schemas/SourcedStringValueResponse"
          },
          "ageOver18": {
            "$ref": "#/components/schemas/SourcedBooleanValueResponse"
          },
          "ageOver21": {
            "$ref": "#/components/schemas/SourcedBooleanValueResponse"
          }
        }
      },
      "ProblemDetailResponse": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "integer",
            "format": "int32"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "timestamp": {
            "$ref": "#/components/schemas/Instant"
          },
          "traceId": {
            "type": "string"
          },
          "invalidParams": {
            "type": "array",
            "items": {}
          }
        }
      },
      "ProfileDetailResponse": {
        "required": [
          "name",
          "steps"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProfileDetailStepResponse"
            }
          }
        }
      },
      "ProfileDetailStepRequest": {
        "type": "object",
        "required": [
          "templateStepId",
          "name",
          "description"
        ],
        "properties": {
          "templateStepId": {
            "$ref": "#/components/schemas/UUID"
          },
          "name": {
            "type": "string",
            "pattern": "\\S"
          },
          "description": {
            "type": "string",
            "pattern": "\\S"
          },
          "stepName": {
            "type": "string"
          },
          "dtpAccountId": {
            "type": "string"
          },
          "stepServerConfiguration": {
            "type": "object",
            "additionalProperties": {}
          },
          "stepSdkConfiguration": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "ProfileDetailStepResponse": {
        "type": "object",
        "required": [
          "templateStepId",
          "name",
          "description"
        ],
        "properties": {
          "templateStepId": {
            "$ref": "#/components/schemas/UUID"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "stepName": {
            "type": "string"
          },
          "dtpAccountId": {
            "type": "string"
          },
          "stepServerConfiguration": {
            "type": "object",
            "additionalProperties": {}
          },
          "stepSdkConfiguration": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "ProfileDetailUpdateRequest": {
        "type": "object",
        "required": [
          "name",
          "steps"
        ],
        "properties": {
          "name": {
            "type": "string",
            "pattern": "\\S"
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProfileDetailStepRequest"
            },
            "minItems": 1
          }
        }
      },
      "ProfileRequest": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "pattern": "\\S"
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StepRequest"
            }
          }
        }
      },
      "ProfileResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "pattern": "\\S"
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProfileStepResponse"
            },
            "minItems": 1
          }
        },
        "required": [
          "name",
          "steps"
        ]
      },
      "ProfileStepResponse": {
        "required": [
          "templateStepId",
          "name",
          "description",
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/UUID"
          },
          "templateStepId": {
            "$ref": "#/components/schemas/UUID"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "stepServerConfigurationId": {
            "$ref": "#/components/schemas/UUID"
          },
          "stepSdkConfiguration": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "RouteReasonCode": {
        "type": "string",
        "enum": [
          "RULES_PASSED",
          "RULES_FAILED",
          "WHEN_NOT_MET"
        ]
      },
      "RuleOperator": {
        "type": "string",
        "enum": [
          "EQUALS",
          "NOT_EQUALS",
          "IN",
          "GREATER_THAN",
          "GREATER_THAN_OR_EQUAL",
          "LESS_THAN",
          "LESS_THAN_OR_EQUAL",
          "BEFORE",
          "ON_OR_BEFORE",
          "AFTER",
          "ON_OR_AFTER"
        ]
      },
      "RuleRequest": {
        "required": [
          "id",
          "step",
          "type",
          "operator",
          "value"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 255,
            "description": "Rule identifier, unique within its rule set. At most 255 characters.",
            "examples": [
              "chip-auth"
            ],
            "pattern": "[^\\p{Cc}\\p{Cf}\\u2028\\u2029]*"
          },
          "step": {
            "$ref": "#/components/schemas/StepDefinitionType",
            "description": "Step definition type whose session steps the rule is evaluated against. The template must have a step of this type.",
            "type": "string"
          },
          "check": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255,
            "description": "Nullable. Name of the check to test. Exactly one of check and field is set. At most 255 characters.",
            "examples": [
              "Chip authentication"
            ],
            "pattern": "[^\\p{Cc}\\p{Cf}\\u2028\\u2029]*"
          },
          "field": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255,
            "description": "Nullable. Result field path to test. Exactly one of check and field is set. At most 255 characters.",
            "examples": [
              "document.expiryDate"
            ],
            "pattern": "[^\\p{Cc}\\p{Cf}\\u2028\\u2029]*"
          },
          "type": {
            "$ref": "#/components/schemas/RuleValueType",
            "description": "Type the value is read as. A check rule is always TEXT.",
            "type": "string"
          },
          "operator": {
            "$ref": "#/components/schemas/RuleOperator",
            "description": "Comparison operator. TEXT allows EQUALS, NOT_EQUALS and IN; NUMBER allows EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN and LESS_THAN_OR_EQUAL; DATE allows EQUALS, NOT_EQUALS, BEFORE, ON_OR_BEFORE, AFTER and ON_OR_AFTER.",
            "type": "string"
          },
          "value": {
            "description": "A string, a number or a number as a string, or a date as yyyy-MM-dd; an array of strings for IN; or, for a DATE rule, an object {\"ref\": \"STEP_TYPE.completedAt\"} naming the date of a step of the template. A string, and each string of an IN array, is at most 255 characters; an IN array has at most 100 strings.",
            "examples": [
              "PASSED"
            ]
          },
          "ignoreIfMissing": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Nullable. Whether the rule holds when the step result has no value for its check or field. False when omitted."
          }
        }
      },
      "RuleResponse": {
        "type": "object",
        "required": [
          "id",
          "step",
          "type",
          "operator",
          "value",
          "ignoreIfMissing"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Rule identifier, unique within its rule set.",
            "examples": [
              "chip-auth"
            ]
          },
          "step": {
            "$ref": "#/components/schemas/StepDefinitionType",
            "description": "Step definition type whose session steps the rule is evaluated against.",
            "type": "string"
          },
          "check": {
            "type": [
              "string",
              "null"
            ],
            "description": "Nullable. Name of the check to test. Exactly one of check and field is set.",
            "examples": [
              "Chip authentication"
            ]
          },
          "field": {
            "type": [
              "string",
              "null"
            ],
            "description": "Nullable. Result field path to test. Exactly one of check and field is set.",
            "examples": [
              "document.expiryDate"
            ]
          },
          "type": {
            "$ref": "#/components/schemas/RuleValueType",
            "description": "Type the value is read as. A check rule is always TEXT.",
            "type": "string"
          },
          "operator": {
            "$ref": "#/components/schemas/RuleOperator"
          },
          "value": {
            "description": "A string, a number as a string or a date as yyyy-MM-dd; an array of strings for IN; or, for a DATE rule, an object {\"ref\": \"STEP_TYPE.field.path\"} naming the date of an earlier step.",
            "examples": [
              "PASSED"
            ]
          },
          "ignoreIfMissing": {
            "type": "boolean",
            "description": "Whether the rule holds when the step result has no value for its check or field."
          }
        }
      },
      "RuleSetRequest": {
        "required": [
          "rules"
        ],
        "type": "object",
        "properties": {
          "rules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RuleRequest"
            },
            "description": "Rules of the rule set, in order. Must not be empty and has at most 100 rules. Rule ids must be unique within the set.",
            "maxItems": 100,
            "minItems": 1
          }
        }
      },
      "RuleValueType": {
        "type": "string",
        "enum": [
          "TEXT",
          "NUMBER",
          "DATE"
        ]
      },
      "SdkAuthenticationDataResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "token": {
            "type": "string"
          }
        }
      },
      "SdkSessionPlanResponse": {
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string"
          },
          "platform": {
            "type": "string"
          },
          "sessionPlan": {
            "$ref": "#/components/schemas/SessionPlanWithSdkTokensResponse"
          }
        }
      },
      "SessionCheckResultResponse": {
        "type": "object",
        "required": [
          "name",
          "source",
          "result"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "type": "string",
            "description": "The metadata.plan.steps[].sessionStepId of the step that produced this check."
          },
          "result": {
            "type": "string"
          },
          "description": {
            "type": "string",
            "description": "Optional provider-supplied explanation of the check outcome."
          }
        }
      },
      "SessionCheckSummaryResponse": {
        "type": "object",
        "required": [
          "numberOfChecks",
          "successful",
          "failed",
          "skipped"
        ],
        "properties": {
          "numberOfChecks": {
            "type": "integer",
            "format": "int32"
          },
          "successful": {
            "type": "integer",
            "format": "int32"
          },
          "failed": {
            "type": "integer",
            "format": "int32"
          },
          "skipped": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "SessionChecksResponse": {
        "type": "object",
        "required": [
          "summary",
          "results"
        ],
        "properties": {
          "summary": {
            "$ref": "#/components/schemas/SessionCheckSummaryResponse"
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionCheckResultResponse"
            }
          }
        }
      },
      "SessionDecision": {
        "type": "string",
        "enum": [
          "PASSED",
          "FAILED"
        ]
      },
      "SessionDecisionReasonResponse": {
        "required": [
          "code"
        ],
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/DecisionReasonCode",
            "description": "Why the session got its decision. SESSION_NOT_SUCCEEDED: the session status is not SUCCEEDED, so no route was evaluated. NO_ROUTE_MATCHED: every step is final and no route matched. RULES_PASSED or RULES_FAILED: the rule sets of the first matching route passed or failed. ALL_ROUTES_RULED_OUT: the session failed early because no route could still match.",
            "readOnly": true,
            "type": "string",
            "examples": [
              "RULES_FAILED"
            ]
          },
          "routes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionRouteReasonResponse"
            },
            "description": "The routes that were considered, in route order, each with why it did not decide or how it decided. Omitted when the code is SESSION_NOT_SUCCEEDED.",
            "readOnly": true
          }
        }
      },
      "SessionDecisionResponse": {
        "required": [
          "result"
        ],
        "type": "object",
        "properties": {
          "result": {
            "$ref": "#/components/schemas/SessionDecision",
            "description": "Final verdict of the template decision policy.",
            "readOnly": true,
            "type": "string",
            "examples": [
              "FAILED"
            ]
          },
          "reason": {
            "$ref": "#/components/schemas/SessionDecisionReasonResponse",
            "description": "Why the session got its decision. Omitted in the session list.",
            "readOnly": true,
            "type": "object"
          }
        }
      },
      "SessionFailedRuleResponse": {
        "type": "object",
        "required": [
          "ruleSet",
          "rule"
        ],
        "properties": {
          "ruleSet": {
            "type": "string",
            "description": "Name of the rule set that contains the failed rule.",
            "readOnly": true,
            "examples": [
              "identity-checks"
            ]
          },
          "rule": {
            "type": "string",
            "description": "Identifier of the rule that did not hold.",
            "readOnly": true,
            "examples": [
              "document-not-expired"
            ]
          },
          "sessionStepId": {
            "type": [
              "string",
              "null"
            ],
            "description": "Session step the failure was raised on, when the rule applies to a single step.",
            "readOnly": true,
            "examples": [
              "step-123"
            ]
          }
        }
      },
      "SessionListResponse": {
        "required": [
          "sessions"
        ],
        "type": "object",
        "properties": {
          "sessions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionSummaryResponse"
            }
          },
          "page": {
            "type": "integer",
            "format": "int32"
          },
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "hasNextPage": {
            "type": "boolean"
          }
        }
      },
      "SessionMetadataResponse": {
        "required": [
          "id",
          "platform",
          "status",
          "templateName",
          "profileId",
          "profileName",
          "sessionSteps",
          "createdAt",
          "updatedAt"
        ],
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/UUID",
            "description": "Session identifier used in session paths.",
            "type": "string",
            "examples": [
              "22222222-2222-2222-2222-222222222222"
            ]
          },
          "platform": {
            "type": "string",
            "description": "Platform selected when the session was created.",
            "examples": [
              "native"
            ]
          },
          "reference": {
            "type": "string",
            "description": "Optional caller-defined correlation identifier from session creation.",
            "examples": [
              "order-12345"
            ]
          },
          "status": {
            "$ref": "#/components/schemas/SessionStatusResponse",
            "description": "Current lifecycle status of the session.",
            "type": "string",
            "examples": [
              "SUCCEEDED"
            ]
          },
          "statusDetails": {
            "$ref": "#/components/schemas/StatusDetailsResponse",
            "description": "Provider-supplied detail about the current status, when available.",
            "type": "object"
          },
          "decision": {
            "$ref": "#/components/schemas/SessionDecisionResponse",
            "description": "Decision of the template decision policy and why, set when the session finishes.",
            "type": "object"
          },
          "conformance": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "$ref": "#/components/schemas/ConformanceResponse"
            },
            "description": "Nullable. Standards the session's flow conforms to, declared by its template. Set only when decision.result is PASSED; omitted otherwise."
          },
          "templateName": {
            "type": "string",
            "description": "Name of the template selected by the profile.",
            "examples": [
              "Identity verification"
            ]
          },
          "profileId": {
            "$ref": "#/components/schemas/UUID",
            "description": "Identifier of the profile used to create the session.",
            "type": "string",
            "examples": [
              "11111111-1111-1111-1111-111111111111"
            ]
          },
          "profileName": {
            "type": "string",
            "description": "Name of the profile used to create the session.",
            "examples": [
              "Standard"
            ]
          },
          "sessionSteps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionStepResponse"
            },
            "description": "Ordered session steps. Use each sessionStepId to retrieve a step result."
          },
          "createdAt": {
            "$ref": "#/components/schemas/OffsetDateTime",
            "description": "When the session was created.",
            "type": "string",
            "examples": [
              "2026-10-01T10:00:00Z"
            ]
          },
          "updatedAt": {
            "$ref": "#/components/schemas/OffsetDateTime",
            "description": "When the session was last updated.",
            "type": "string",
            "examples": [
              "2026-10-01T10:02:00Z"
            ]
          }
        }
      },
      "SessionPlanEvidenceResponse": {
        "required": [
          "sessionId",
          "ruleSets",
          "steps"
        ],
        "type": "object",
        "properties": {
          "sessionId": {
            "$ref": "#/components/schemas/UUID"
          },
          "templateId": {
            "$ref": "#/components/schemas/UUID"
          },
          "templateName": {
            "type": "string"
          },
          "profileId": {
            "$ref": "#/components/schemas/UUID"
          },
          "profileName": {
            "type": "string"
          },
          "ruleSets": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/RuleResponse"
              }
            },
            "description": "Named rule sets referenced by start conditions and routes. Empty when none are configured."
          },
          "decisionPolicy": {
            "description": "Nullable. Omitted when the plan has no decision policy.",
            "type": "object",
            "anyOf": [
              {
                "$ref": "#/components/schemas/DecisionPolicyResponse"
              },
              {
                "type": "null"
              }
            ]
          },
          "conformance": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "$ref": "#/components/schemas/ConformanceResponse"
            },
            "description": "Nullable. Standards the flow conforms to, declared by the template. Omitted when none are declared."
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionPlanEvidenceStepResponse"
            }
          }
        }
      },
      "SessionPlanEvidenceStepResponse": {
        "type": "object",
        "required": [
          "index",
          "type",
          "sessionStepId"
        ],
        "properties": {
          "index": {
            "type": "integer",
            "format": "int32"
          },
          "type": {
            "$ref": "#/components/schemas/StepDefinitionType"
          },
          "sessionStepId": {
            "type": "string"
          },
          "startWhen": {
            "description": "Nullable. Omitted when the step started without a condition.",
            "type": "object",
            "anyOf": [
              {
                "$ref": "#/components/schemas/StepConditionResponse"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "SessionPlanWithSdkTokensResponse": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/UUID"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "profileId": {
            "$ref": "#/components/schemas/UUID"
          },
          "profileName": {
            "type": "string"
          },
          "sessionSteps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionStepWithSdkTokenResponse"
            }
          },
          "sdkConfiguration": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "SessionPlatform": {
        "type": "string",
        "enum": [
          "native",
          "web"
        ]
      },
      "SessionResponse": {
        "required": [
          "metadata"
        ],
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/SessionMetadataResponse",
            "description": "Always present. Identifies the session and reports its current status and ordered plan steps.",
            "type": "object"
          },
          "aggregatedIdentity": {
            "$ref": "#/components/schemas/AggregatedIdentityResponse",
            "description": "Omitted until a terminal session aggregate has been persisted. A newly finalized session with no normalized fields returns an empty object.",
            "type": "object"
          },
          "evidenceFiles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EvidenceResponse"
            },
            "description": "Evidence metadata collected across the session. After the session is finalized it includes the SESSION_RESULT and SESSION_PLAN evidences produced by Verify, each once its write has succeeded; a failed write is retried, so either can be missing for a while. Download file content with the evidence endpoint."
          },
          "checks": {
            "$ref": "#/components/schemas/SessionChecksResponse",
            "description": "Omitted when the session has no checks.",
            "type": "object"
          }
        }
      },
      "SessionRouteReasonResponse": {
        "type": "object",
        "required": [
          "route",
          "code"
        ],
        "properties": {
          "route": {
            "type": "integer",
            "format": "int32",
            "description": "Index of the route in the decision policy of the session plan.",
            "readOnly": true,
            "examples": [
              0
            ]
          },
          "code": {
            "$ref": "#/components/schemas/RouteReasonCode",
            "description": "WHEN_NOT_MET: the step statuses did not match the route's when. RULES_PASSED or RULES_FAILED: the route's rule sets passed or failed.",
            "readOnly": true,
            "type": "string",
            "examples": [
              "WHEN_NOT_MET"
            ]
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionUnmetStepResponse"
            },
            "description": "Step types of the route's when that did not match. Present only for WHEN_NOT_MET.",
            "readOnly": true
          },
          "failedRules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionFailedRuleResponse"
            },
            "description": "Rules that did not hold. Present only for RULES_FAILED.",
            "readOnly": true
          }
        }
      },
      "SessionStatusResponse": {
        "type": "string",
        "enum": [
          "CREATED",
          "IN_PROGRESS",
          "PROCESSING",
          "SUCCEEDED",
          "REJECTED",
          "INCONCLUSIVE",
          "FAILED",
          "CANCELED",
          "EXPIRED"
        ]
      },
      "SessionStepCheckRequest": {
        "type": "object",
        "required": [
          "name",
          "result"
        ],
        "properties": {
          "name": {
            "type": "string",
            "pattern": "\\S"
          },
          "result": {
            "type": "string",
            "pattern": "\\S"
          },
          "description": {
            "type": "string",
            "description": "Optional provider-supplied explanation of the check outcome."
          }
        }
      },
      "SessionStepMetadataResponse": {
        "required": [
          "sessionStepId",
          "index",
          "displayName",
          "stepName",
          "status"
        ],
        "type": "object",
        "properties": {
          "sessionStepId": {
            "type": "string"
          },
          "index": {
            "type": "integer",
            "format": "int32"
          },
          "displayName": {
            "type": "string"
          },
          "stepName": {
            "$ref": "#/components/schemas/SessionStepName"
          },
          "status": {
            "$ref": "#/components/schemas/SessionStepStatusResponse"
          },
          "statusDetails": {
            "$ref": "#/components/schemas/StatusDetailsResponse"
          }
        }
      },
      "SessionStepName": {
        "type": "string",
        "enum": [
          "AgentVerification",
          "ExternalWebView",
          "Video",
          "NFC",
          "FaceMatch"
        ]
      },
      "SessionStepResponse": {
        "type": "object",
        "required": [
          "index",
          "sessionStepId",
          "displayName",
          "stepName",
          "stepType",
          "status",
          "stepConfigurationId",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "index": {
            "type": "integer",
            "format": "int32"
          },
          "sessionStepId": {
            "type": "string",
            "description": "Identifier for this session step. Use it as {sessionStepId} when retrieving the detailed step result."
          },
          "stepConfigurationId": {
            "$ref": "#/components/schemas/UUID"
          },
          "displayName": {
            "type": "string"
          },
          "stepName": {
            "$ref": "#/components/schemas/SessionStepName"
          },
          "stepType": {
            "$ref": "#/components/schemas/StepType"
          },
          "status": {
            "$ref": "#/components/schemas/SessionStepStatusResponse"
          },
          "statusDetails": {
            "$ref": "#/components/schemas/StatusDetailsResponse"
          },
          "createdAt": {
            "$ref": "#/components/schemas/OffsetDateTime"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/OffsetDateTime"
          }
        }
      },
      "SessionStepResultContactAndAddressRequest": {
        "type": "object",
        "properties": {
          "fullAddress": {
            "type": "string"
          },
          "addressStreet": {
            "type": "string"
          },
          "addressHouseNumber": {
            "type": "string"
          },
          "addressCity": {
            "type": "string"
          },
          "addressPostalCode": {
            "type": "string"
          },
          "addressState": {
            "type": "string"
          },
          "addressCountry": {
            "type": "string",
            "pattern": "[A-Z]{2}"
          },
          "email": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string",
            "pattern": "\\+[1-9][0-9]{1,14}"
          }
        }
      },
      "SessionStepResultDocumentRequest": {
        "type": "object",
        "properties": {
          "documentNumber": {
            "type": "string"
          },
          "mrz": {
            "type": "string"
          },
          "documentType": {
            "$ref": "#/components/schemas/DocumentType"
          },
          "documentCode": {
            "type": "string"
          },
          "documentClassification": {
            "type": "string"
          },
          "issuingCountry": {
            "type": "string",
            "pattern": "[A-Z]{2}"
          },
          "issuingAuthority": {
            "type": "string"
          },
          "dateOfIssue": {
            "$ref": "#/components/schemas/LocalDate"
          },
          "dateOfExpiry": {
            "$ref": "#/components/schemas/LocalDate"
          }
        }
      },
      "SessionStepResultIdentityRequest": {
        "type": "object",
        "required": [
          "personalDetails",
          "contactAndAddress",
          "document"
        ],
        "properties": {
          "personalDetails": {
            "$ref": "#/components/schemas/SessionStepResultPersonalDetailsRequest"
          },
          "contactAndAddress": {
            "$ref": "#/components/schemas/SessionStepResultContactAndAddressRequest"
          },
          "document": {
            "$ref": "#/components/schemas/SessionStepResultDocumentRequest"
          }
        }
      },
      "SessionStepResultMetadataRequest": {
        "type": "object",
        "required": [
          "status"
        ],
        "properties": {
          "status": {
            "$ref": "#/components/schemas/SessionStepResultStatus",
            "description": "SDK_STEP_COMPLETED, SDK_DATA_AVAILABLE, and IN_PROGRESS publish nonterminal result data. All other values are terminal outcomes.",
            "type": "string"
          },
          "statusDetails": {
            "$ref": "#/components/schemas/StatusDetailsRequest"
          }
        }
      },
      "SessionStepResultPersonalDetailsRequest": {
        "type": "object",
        "properties": {
          "familyName": {
            "type": "string"
          },
          "givenNames": {
            "type": "string"
          },
          "birthFamilyName": {
            "type": "string"
          },
          "birthGivenNames": {
            "type": "string"
          },
          "dateOfBirth": {
            "$ref": "#/components/schemas/LocalDate"
          },
          "placeOfBirth": {
            "type": "string"
          },
          "nationality": {
            "type": "string",
            "pattern": "[A-Z]{2}"
          },
          "gender": {
            "$ref": "#/components/schemas/Gender"
          },
          "nin": {
            "type": "string"
          },
          "ageOver18": {
            "type": "boolean"
          },
          "ageOver21": {
            "type": "boolean"
          }
        }
      },
      "SessionStepResultRequest": {
        "description": "Submits normalized Session Step data. SDK_STEP_COMPLETED, SDK_DATA_AVAILABLE, and IN_PROGRESS replace available nonterminal identity and status details; evidence-files and checks are accepted only with a terminal status. The first terminal submission is immutable; identical terminal retries are accepted as no-ops and conflicting terminal retries are rejected. The mediator contract spells the evidence list evidence-files; the read responses spell it evidenceFiles, and evidenceFiles is not accepted here.",
        "type": "object",
        "required": [
          "metadata"
        ],
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/SessionStepResultMetadataRequest"
          },
          "identity": {
            "$ref": "#/components/schemas/SessionStepResultIdentityRequest"
          },
          "evidence-files": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EvidenceRequest"
            }
          },
          "checks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionStepCheckRequest"
            }
          }
        }
      },
      "SessionStepResultResponse": {
        "required": [
          "metadata"
        ],
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/SessionStepMetadataResponse",
            "description": "Always present. Identifies the step and reports its current status.",
            "type": "object"
          },
          "identity": {
            "$ref": "#/components/schemas/IdentityResponse",
            "description": "Normalized identity values produced by this step, when any.",
            "type": "object"
          },
          "evidenceFiles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EvidenceResponse"
            },
            "description": "Evidence metadata produced by this step, when any."
          },
          "checks": {
            "$ref": "#/components/schemas/SessionChecksResponse",
            "description": "Omitted when the step has no checks.",
            "type": "object"
          }
        }
      },
      "SessionStepResultStatus": {
        "type": "string",
        "enum": [
          "SDK_STEP_COMPLETED",
          "SDK_DATA_AVAILABLE",
          "IN_PROGRESS",
          "SUCCEEDED",
          "REJECTED",
          "NFC_NOT_SUPPORTED",
          "INCONCLUSIVE",
          "FAILED",
          "TIMED_OUT"
        ]
      },
      "SessionStepStatusResponse": {
        "type": "string",
        "enum": [
          "PENDING",
          "STARTED",
          "SDK_STEP_COMPLETED",
          "SDK_DATA_AVAILABLE",
          "IN_PROGRESS",
          "SUCCEEDED",
          "REJECTED",
          "NFC_NOT_SUPPORTED",
          "USER_ABORTED",
          "INCONCLUSIVE",
          "FAILED",
          "TIMED_OUT",
          "SKIPPED",
          "CANCELED"
        ]
      },
      "SessionStepStatusUpdate": {
        "type": "string",
        "enum": [
          "STARTED",
          "SDK_STEP_COMPLETED",
          "NFC_NOT_SUPPORTED",
          "USER_ABORTED",
          "FAILED"
        ]
      },
      "SessionStepWithSdkTokenResponse": {
        "required": [
          "index",
          "sessionStepId",
          "displayName",
          "stepName",
          "stepType",
          "status",
          "stepConfigurationId",
          "createdAt",
          "updatedAt"
        ],
        "type": "object",
        "properties": {
          "index": {
            "type": "integer",
            "format": "int32"
          },
          "sessionStepId": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "stepName": {
            "$ref": "#/components/schemas/SessionStepName"
          },
          "stepType": {
            "$ref": "#/components/schemas/StepType"
          },
          "status": {
            "$ref": "#/components/schemas/SessionStepStatusResponse"
          },
          "statusDetails": {
            "$ref": "#/components/schemas/StatusDetailsResponse"
          },
          "entryPoint": {
            "type": "string"
          },
          "stepConfigurationId": {
            "$ref": "#/components/schemas/UUID"
          },
          "sdkAuthenticationData": {
            "$ref": "#/components/schemas/SdkAuthenticationDataResponse"
          },
          "sdkConfiguration": {
            "type": "object",
            "additionalProperties": {}
          },
          "createdAt": {
            "$ref": "#/components/schemas/OffsetDateTime"
          },
          "updatedAt": {
            "$ref": "#/components/schemas/OffsetDateTime"
          }
        }
      },
      "SessionSummaryResponse": {
        "type": "object",
        "required": [
          "id",
          "status",
          "templateId",
          "profileId",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/UUID"
          },
          "status": {
            "$ref": "#/components/schemas/SessionStatusResponse"
          },
          "decision": {
            "$ref": "#/components/schemas/SessionDecisionResponse",
            "description": "Decision of the template decision policy, set when the session finishes. The list carries only its result.",
            "type": "object"
          },
          "templateId": {
            "$ref": "#/components/schemas/UUID"
          },
          "profileId": {
            "$ref": "#/components/schemas/UUID"
          },
          "createdAt": {
            "$ref": "#/components/schemas/OffsetDateTime",
            "description": "When the session was created.",
            "type": "string",
            "examples": [
              "2026-10-01T10:00:00Z"
            ]
          },
          "updatedAt": {
            "$ref": "#/components/schemas/OffsetDateTime",
            "description": "When the session was last updated.",
            "type": "string",
            "examples": [
              "2026-10-01T10:02:00Z"
            ]
          }
        }
      },
      "SessionTokenResponse": {
        "type": "object",
        "properties": {
          "sessionId": {
            "$ref": "#/components/schemas/UUID",
            "description": "The unique identifier of your newly created identity proofing session. Use this value to retrieve session details, steps and evidence in the [Get session](https://developer.signicat.com/apis/id-proofing/#tag/public/operation/getSession) endpoint.",
            "type": "string",
            "examples": [
              "22222222-2222-2222-2222-222222222222"
            ]
          },
          "sdkToken": {
            "type": "string",
            "description": "Token for the client SDK to run this session. Treat it as a secret and do not use it to call account-level public endpoints.",
            "examples": [
              "eyJhbGciOi..."
            ]
          }
        }
      },
      "SessionUnmetStepResponse": {
        "type": "object",
        "required": [
          "type",
          "allowed",
          "actual"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/StepDefinitionType",
            "description": "Step type of the route's when.",
            "readOnly": true,
            "type": "string",
            "examples": [
              "NFC"
            ]
          },
          "allowed": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionStepStatusResponse"
            },
            "description": "Statuses the route's when allows for this step type.",
            "readOnly": true
          },
          "actual": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionStepStatusResponse"
            },
            "description": "Statuses of the session steps of this type, in step order. Empty when the session has no step of this type.",
            "readOnly": true
          }
        }
      },
      "SourcedBooleanValueResponse": {
        "required": [
          "value",
          "source"
        ],
        "type": "object",
        "properties": {
          "value": {
            "type": "boolean"
          },
          "source": {
            "type": "string"
          }
        }
      },
      "SourcedCountryCodeValueResponse": {
        "required": [
          "value",
          "source"
        ],
        "type": "object",
        "properties": {
          "value": {
            "type": "string"
          },
          "source": {
            "type": "string"
          }
        }
      },
      "SourcedDateValueResponse": {
        "required": [
          "value",
          "source"
        ],
        "type": "object",
        "properties": {
          "value": {
            "$ref": "#/components/schemas/LocalDate"
          },
          "source": {
            "type": "string"
          }
        }
      },
      "SourcedDocumentTypeValueResponse": {
        "required": [
          "value",
          "source"
        ],
        "type": "object",
        "properties": {
          "value": {
            "$ref": "#/components/schemas/DocumentType"
          },
          "source": {
            "type": "string"
          }
        }
      },
      "SourcedGenderValueResponse": {
        "required": [
          "value",
          "source"
        ],
        "type": "object",
        "properties": {
          "value": {
            "$ref": "#/components/schemas/Gender"
          },
          "source": {
            "type": "string"
          }
        }
      },
      "SourcedNumberValueResponse": {
        "required": [
          "value",
          "source"
        ],
        "type": "object",
        "properties": {
          "value": {
            "type": "number",
            "format": "double"
          },
          "source": {
            "type": "string"
          }
        }
      },
      "SourcedStringValueResponse": {
        "required": [
          "value",
          "source"
        ],
        "type": "object",
        "properties": {
          "value": {
            "type": "string"
          },
          "source": {
            "type": "string"
          }
        }
      },
      "StatusDetailsRequest": {
        "type": "object",
        "required": [
          "code",
          "title",
          "detail"
        ],
        "properties": {
          "code": {
            "type": "string",
            "pattern": "\\S"
          },
          "title": {
            "type": "string",
            "pattern": "\\S"
          },
          "detail": {
            "type": "string",
            "pattern": "\\S"
          }
        }
      },
      "StatusDetailsResponse": {
        "type": "object",
        "required": [
          "code",
          "title",
          "detail"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "sourceSessionStepId": {
            "type": "string",
            "readOnly": true
          },
          "failedRules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FailedRuleResponse"
            },
            "readOnly": true
          }
        }
      },
      "StatusTransition": {
        "required": [
          "status",
          "occurredAt"
        ],
        "description": "One status that was entered, and when it was entered.",
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "The status that was entered.",
            "examples": [
              "IN_PROGRESS"
            ]
          },
          "occurredAt": {
            "$ref": "#/components/schemas/OffsetDateTime",
            "description": "When the status was entered.",
            "type": "string",
            "examples": [
              "2026-08-13T16:04:11.412291Z"
            ]
          }
        }
      },
      "StepConditionRequest": {
        "type": "object",
        "properties": {
          "when": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "maxItems": 20
            },
            "description": "Nullable. Final step statuses per step definition type that must hold. Omitted or empty means always."
          },
          "ruleSets": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string",
              "pattern": "[^\\p{Cc}\\p{Cf}\\u2028\\u2029]*",
              "maxLength": 100
            },
            "description": "Nullable. Names of the rule sets that must hold, taken from the template ruleSets.",
            "maxItems": 100
          }
        }
      },
      "StepConditionResponse": {
        "type": "object",
        "required": [
          "when",
          "ruleSets"
        ],
        "properties": {
          "when": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Final step statuses per step definition type that must hold. Empty means always."
          },
          "ruleSets": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Names of the rule sets that must hold, taken from the template ruleSets."
          }
        }
      },
      "StepDefinitionType": {
        "type": "string",
        "enum": [
          "Video",
          "NFC",
          "AGENT_VERIFICATION",
          "FACE_MATCH",
          "EXTERNAL_WEB_VIEW"
        ]
      },
      "StepRequest": {
        "type": "object",
        "required": [
          "templateStepId",
          "name",
          "description"
        ],
        "properties": {
          "templateStepId": {
            "$ref": "#/components/schemas/UUID"
          },
          "name": {
            "type": "string",
            "pattern": "\\S"
          },
          "description": {
            "type": "string",
            "pattern": "\\S"
          },
          "stepServerConfiguration": {
            "type": "object",
            "additionalProperties": {}
          },
          "stepSdkConfigurationId": {
            "$ref": "#/components/schemas/UUID"
          },
          "stepSdkConfiguration": {
            "type": "object",
            "additionalProperties": {}
          }
        }
      },
      "StepType": {
        "type": "string",
        "enum": [
          "SDK",
          "OFFLINE",
          "EXTERNAL_WEB_VIEW"
        ]
      },
      "TemplateRequest": {
        "required": [
          "name",
          "steps"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255,
            "description": "Template name. At most 255 characters.",
            "examples": [
              "NFC and video"
            ],
            "pattern": "[^\\p{Cc}\\p{Cf}\\u2028\\u2029]*"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 2000,
            "description": "Nullable. Template description. At most 2000 characters."
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TemplateStepRequest"
            },
            "description": "Steps of the template. Must not be empty and has at most 20 steps.",
            "maxItems": 20,
            "minItems": 1
          },
          "ruleSets": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/RuleRequest"
              },
              "maxItems": 100,
              "minItems": 1
            },
            "description": "Nullable. Named rule sets, in order, referenced by start conditions and routes. At most 100 rule sets, each named with at most 100 characters and holding 1 to 100 rules."
          },
          "decisionPolicy": {
            "description": "Nullable. Omit for a template without a decision policy.",
            "type": [
              "object",
              "null"
            ],
            "anyOf": [
              {
                "$ref": "#/components/schemas/DecisionPolicyRequest"
              },
              {
                "type": "null"
              }
            ]
          },
          "conformance": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "$ref": "#/components/schemas/ConformanceRequest"
            },
            "description": "Nullable. Standards the template conforms to, each at most once. Omit for none.",
            "maxItems": 20
          }
        }
      },
      "TemplateResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "steps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TemplateStepResponse"
            }
          },
          "ruleSets": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/RuleResponse"
              }
            },
            "description": "Named rule sets referenced by start conditions and routes. Empty when none are configured."
          },
          "decisionPolicy": {
            "description": "Nullable. Omitted when the template has no decision policy.",
            "type": [
              "object",
              "null"
            ],
            "anyOf": [
              {
                "$ref": "#/components/schemas/DecisionPolicyResponse"
              },
              {
                "type": "null"
              }
            ]
          },
          "conformance": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "$ref": "#/components/schemas/ConformanceResponse"
            },
            "description": "Nullable. Standards the template conforms to. Omitted when the template declares none."
          }
        }
      },
      "TemplateStepRequest": {
        "type": "object",
        "required": [
          "stepDefinitionId",
          "index",
          "type"
        ],
        "properties": {
          "id": {
            "description": "Nullable. Id of the step. Required when a template is updated, where it names an existing step of the template. Ignored when a template is created.",
            "type": [
              "string",
              "null"
            ],
            "anyOf": [
              {
                "$ref": "#/components/schemas/UUID"
              },
              {
                "type": "null"
              }
            ]
          },
          "stepDefinitionId": {
            "$ref": "#/components/schemas/UUID",
            "description": "Step definition the step runs.",
            "type": "string"
          },
          "index": {
            "type": "integer",
            "format": "int32",
            "description": "Position of the step in the template, unique within the template.",
            "minimum": 0
          },
          "type": {
            "$ref": "#/components/schemas/StepType",
            "description": "How the step runs: SDK for Video and NFC, OFFLINE for AgentVerification and FaceMatch, EXTERNAL_WEB_VIEW for ExternalWebView.",
            "type": "string"
          },
          "startWhen": {
            "description": "Nullable. Omit for a step that starts without a condition.",
            "type": [
              "object",
              "null"
            ],
            "anyOf": [
              {
                "$ref": "#/components/schemas/StepConditionRequest"
              },
              {
                "type": "null"
              }
            ]
          },
          "mediatorSettings": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": {},
            "description": "Nullable. Default mediator settings of the step, a map from setting key to a scalar value. Each key must be a mediator setting of the step's definition, with a value of that setting's type. At most 20 settings, each key at most 100 characters. Omit or send null for none."
          }
        }
      },
      "TemplateStepResponse": {
        "required": [
          "id",
          "stepDefinitionId",
          "index",
          "name",
          "type"
        ],
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/UUID"
          },
          "stepDefinitionId": {
            "$ref": "#/components/schemas/UUID"
          },
          "index": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/StepType"
          },
          "startWhen": {
            "description": "Nullable. Omitted when the step starts without a condition.",
            "type": [
              "object",
              "null"
            ],
            "anyOf": [
              {
                "$ref": "#/components/schemas/StepConditionResponse"
              },
              {
                "type": "null"
              }
            ]
          },
          "mediatorSettings": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": {},
            "description": "Nullable. Default mediator settings of the step, a map from setting key to a scalar value. Omitted when the step has none."
          }
        }
      },
      "UUID": {
        "type": "string",
        "format": "uuid",
        "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
      },
      "UpdateSessionStepStatusRequest": {
        "type": "object",
        "required": [
          "status"
        ],
        "properties": {
          "status": {
            "$ref": "#/components/schemas/SessionStepStatusUpdate"
          },
          "statusDetails": {
            "$ref": "#/components/schemas/StatusDetailsRequest"
          }
        }
      }
    },
    "securitySchemes": {
      "SecurityScheme": {
        "description": "Authentication",
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "Opaque"
      }
    }
  }
}