> For the complete documentation index, see [llms.txt](https://docs.meeco.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.meeco.me/openapi-docs/svx-api/svx-verify.md).

# SVX Verify

## List SVX Verify sessions

> List SVX Verify sessions with pagination and optional filters.\
> Each session record contains current processing/submission status, metadata (created/updated timestamps), and a summary of any verified claims collected so far.<br>

```json
{"openapi":"3.1.0","info":{"title":"SVX Wallet API","version":"4.0.1"},"servers":[{"url":"https://zyfla-wallet-sandbox.meeco.cloud","description":"SVX Wallet deployment (relative)"}],"security":[{},{"bearerAuth":[]},{"mutualTLS":[]}],"components":{"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"},"mutualTLS":{"type":"mutualTLS"}},"schemas":{"PaginatedSvxVerifySessionsResponseDto":{"type":"object","properties":{"sessions":{"type":"array","items":{"$ref":"#/components/schemas/SvxVerifySessionModelDto"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["sessions","meta"]},"SvxVerifySessionModelDto":{"properties":{"id":{"description":"SVX Verify session identifier.","type":"string","format":"uuid"},"submission_status":{"description":"Current submission status recorded against the session.","type":"string","enum":["verified","pending","failed"]},"step":{"description":"Current step of the verification flow.","type":"string","enum":["idle","index","share","complete","error","aborted"]},"presentation_template_id":{"description":"Presentation template identifier used for the session.","type":"string","format":"uuid"},"created_at":{"description":"Timestamp the session was created.","type":"string","format":"date-time"},"updated_at":{"description":"Timestamp the session was last updated.","type":"string","format":"date-time"},"expires_at":{"description":"Timestamp the session expires.","type":"string","format":"date-time"},"error_code":{"description":"Error code recorded against the session when verification fails.","type":["string","null"]},"error_description":{"description":"Human-readable description of the recorded session error.","type":["string","null"]},"verified_claims":{"description":"Claims verified from the presentation response, keyed by claim name.","type":"object","additionalProperties":true}},"required":["id","submission_status","step","presentation_template_id","created_at","updated_at","expires_at","error_code","error_description","verified_claims"],"type":"object"},"Meta":{"type":"object","properties":{"order_by":{"type":"string"},"order":{"type":"string","enum":["ASC","DESC"]},"order_from_params":{"type":"boolean"},"per_page":{"type":"number"},"per_page_from_params":{"type":"boolean"},"records_count":{"type":"number"},"page":{"type":"number"},"page_count":{"type":"number"}},"required":["order_by","order","order_from_params","per_page","per_page_from_params","records_count","page","page_count"]},"InvalidPaginationParamError":{"properties":{"error":{"description":"Unique error identifier","enum":["invalid_pagination_param"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"InvalidRequestPayloadError":{"properties":{"error":{"description":"Unique error identifier","enum":["invalid_request_payload"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"ListSessionsError":{"properties":{"error":{"description":"Unique error identifier","enum":["list_sessions_error"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"InternalServerError":{"properties":{"error":{"description":"Unique error identifier","enum":["internal_server_error"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"}}},"paths":{"/verify/sessions":{"get":{"summary":"List SVX Verify sessions","description":"List SVX Verify sessions with pagination and optional filters.\nEach session record contains current processing/submission status, metadata (created/updated timestamps), and a summary of any verified claims collected so far.\n","operationId":"SessionsController_listSessions","parameters":[{"in":"query","name":"order","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"in":"query","name":"order_by","required":false,"schema":{"type":"string","enum":["created_at","updated_at"]}},{"in":"query","name":"per_page","required":false,"schema":{"type":"integer","minimum":1,"maximum":50}},{"in":"query","name":"page","required":false,"schema":{"type":"integer","minimum":1}},{"in":"query","name":"submission_status","required":false,"schema":{"type":"string","enum":["verified","pending","failed"]}},{"in":"query","name":"created_at_from","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"created_at_to","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"updated_at_from","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"updated_at_to","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSvxVerifySessionsResponseDto"}}},"description":"SVX Verify sessions successfully loaded"},"400":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidPaginationParamError"},{"$ref":"#/components/schemas/InvalidRequestPayloadError"}]}}},"description":""},"500":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ListSessionsError"},{"$ref":"#/components/schemas/InternalServerError"}]}}},"description":""}},"tags":["SVX Verify"]}}}}
```

## Create an SVX Verify session

> Create an SVX Verify session for a configured presentation template.\
> This server-side call initiates a hosted identity verification flow and returns a session identifier and a redirect URL.\
> Use the returned \`id\` to poll session status or to fetch verified claims after the user completes the hosted flow.<br>

```json
{"openapi":"3.1.0","info":{"title":"SVX Wallet API","version":"4.0.1"},"servers":[{"url":"https://zyfla-wallet-sandbox.meeco.cloud","description":"SVX Wallet deployment (relative)"}],"security":[{},{"bearerAuth":[]},{"mutualTLS":[]}],"components":{"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"},"mutualTLS":{"type":"mutualTLS"}},"schemas":{"CreateSvxVerifySessionPayloadDto":{"properties":{"return_url":{"description":"URI to return to when the verification flow exits or is aborted.","type":"string","format":"uri"},"success_url":{"description":"URI to return to after a successful verification flow.","type":"string","format":"uri"},"presentation_template_id":{"description":"Whitelisted presentation template identifier to use for this session.","type":"string","format":"uuid"}},"required":["return_url","success_url","presentation_template_id"],"type":"object"},"CreateSvxVerifySessionResponseDto":{"properties":{"id":{"description":"Created session identifier.","type":"string","format":"uuid"},"url":{"description":"Verification URL for the browser-based verification flow.","type":"string","format":"uri"}},"required":["id","url"],"type":"object"},"InvalidRequestPayloadError":{"properties":{"error":{"description":"Unique error identifier","enum":["invalid_request_payload"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"InvalidRequestError":{"properties":{"error":{"description":"Unique error identifier","enum":["invalid_request"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"CreateSessionError":{"properties":{"error":{"description":"Unique error identifier","enum":["create_session_error"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"InternalServerError":{"properties":{"error":{"description":"Unique error identifier","enum":["internal_server_error"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"}}},"paths":{"/verify/sessions":{"post":{"summary":"Create an SVX Verify session","description":"Create an SVX Verify session for a configured presentation template.\nThis server-side call initiates a hosted identity verification flow and returns a session identifier and a redirect URL.\nUse the returned `id` to poll session status or to fetch verified claims after the user completes the hosted flow.\n","operationId":"SessionsController_createSession","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSvxVerifySessionPayloadDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSvxVerifySessionResponseDto"}}},"description":"SVX Verify session created"},"400":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InvalidRequestPayloadError"},{"$ref":"#/components/schemas/InvalidRequestError"}]}}},"description":""},"500":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateSessionError"},{"$ref":"#/components/schemas/InternalServerError"}]}}},"description":""}},"tags":["SVX Verify"]}}}}
```

## Get an SVX Verify session

> Retrieve an SVX Verify session by identifier. The response includes the session status, redirect URLs, lifecycle timestamps, and any verified claims produced by the hosted verification flow.\
> Sessions may expire; use the \`id\` returned by the create call to locate results after the user returns from the hosted experience.<br>

```json
{"openapi":"3.1.0","info":{"title":"SVX Wallet API","version":"4.0.1"},"servers":[{"url":"https://zyfla-wallet-sandbox.meeco.cloud","description":"SVX Wallet deployment (relative)"}],"security":[{},{"bearerAuth":[]},{"mutualTLS":[]}],"components":{"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"},"mutualTLS":{"type":"mutualTLS"}},"schemas":{"GetSvxVerifySessionResponseDto":{"properties":{"session_id":{"description":"SVX Verify session identifier.","type":"string","format":"uuid"},"status":{"description":"Current verification status for the session.","type":"string","enum":["idle","pending","verified","failed"]},"verified_claims":{"description":"Claims verified from the presentation response, keyed by claim name.","type":"object","additionalProperties":true},"error":{"description":"Error code recorded against the session when verification fails.","type":["string","null"]},"error_description":{"description":"Human-readable description of the recorded session error.","type":["string","null"]}},"required":["session_id","status","verified_claims"],"type":"object"},"InvalidPathParamError":{"properties":{"error":{"description":"Unique error identifier","enum":["invalid_path_param"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"SessionNotFoundError":{"properties":{"error":{"description":"Unique error identifier","enum":["session_not_found"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"GetSessionError":{"properties":{"error":{"description":"Unique error identifier","enum":["get_session_error"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"InternalServerError":{"properties":{"error":{"description":"Unique error identifier","enum":["internal_server_error"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"}}},"paths":{"/verify/sessions/{id}":{"get":{"summary":"Get an SVX Verify session","description":"Retrieve an SVX Verify session by identifier. The response includes the session status, redirect URLs, lifecycle timestamps, and any verified claims produced by the hosted verification flow.\nSessions may expire; use the `id` returned by the create call to locate results after the user returns from the hosted experience.\n","operationId":"SessionsController_getSession","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSvxVerifySessionResponseDto"}}},"description":"SVX Verify session loaded"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPathParamError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionNotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GetSessionError"},{"$ref":"#/components/schemas/InternalServerError"}]}}},"description":""}},"tags":["SVX Verify"]}}}}
```

## Get an SVX Verify presentation request JWT

> Retrieve the raw signed JWT presentation request associated with an SVX Verify session.\
> Clients use this JWT when a raw authorization/request token is required by downstream components or wallets.\
> Depending on configuration (\`svx\_verify.policy.presentation\_request\_multiple\_loads\_enabled\`) the JWT may be single-use and readable only once.<br>

```json
{"openapi":"3.1.0","info":{"title":"SVX Wallet API","version":"4.0.1"},"servers":[{"url":"https://zyfla-wallet-sandbox.meeco.cloud","description":"SVX Wallet deployment (relative)"}],"security":[],"paths":{"/verify/verification/{id}/request":{"get":{"summary":"Get an SVX Verify presentation request JWT","description":"Retrieve the raw signed JWT presentation request associated with an SVX Verify session.\nClients use this JWT when a raw authorization/request token is required by downstream components or wallets.\nDepending on configuration (`svx_verify.policy.presentation_request_multiple_loads_enabled`) the JWT may be single-use and readable only once.\n","operationId":"VerificationController_getPresentationRequestToken","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"content":{"application/jwt":{"schema":{"type":"string"}}},"description":"Presentation request JWT successfully loaded"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SessionNotFoundError"},{"$ref":"#/components/schemas/SvxVerifyPresentationRequestNotFoundError"}]}}},"description":""},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":""}},"tags":["SVX Verify"]}}},"components":{"schemas":{"ForbiddenError":{"properties":{"error":{"description":"Unique error identifier","enum":["forbidden"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"SessionNotFoundError":{"properties":{"error":{"description":"Unique error identifier","enum":["session_not_found"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"SvxVerifyPresentationRequestNotFoundError":{"properties":{"error":{"description":"Unique error identifier","enum":["presentation_request_not_found"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"InternalServerError":{"properties":{"error":{"description":"Unique error identifier","enum":["internal_server_error"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"}}}}
```

## Get SVX Verify presentation status

> Retrieve the current processing status for an SVX Verify session and brief verification result metadata.\
> This endpoint is intended to be polled from the browser during the hosted flow and therefore may require the session cookie established by the verification UI.<br>

```json
{"openapi":"3.1.0","info":{"title":"SVX Wallet API","version":"4.0.1"},"servers":[{"url":"https://zyfla-wallet-sandbox.meeco.cloud","description":"SVX Wallet deployment (relative)"}],"security":[],"paths":{"/verify/verification/{id}/status":{"get":{"summary":"Get SVX Verify presentation status","description":"Retrieve the current processing status for an SVX Verify session and brief verification result metadata.\nThis endpoint is intended to be polled from the browser during the hosted flow and therefore may require the session cookie established by the verification UI.\n","operationId":"VerificationController_getPresentationStatus","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SvxVerifyPresentationStatusResponseDto"}}},"description":"Presentation status successfully loaded"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SessionNotFoundError"},{"$ref":"#/components/schemas/SessionExpiredError"}]}}},"description":""},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":""}},"tags":["SVX Verify"]}}},"components":{"schemas":{"SvxVerifyPresentationStatusResponseDto":{"properties":{"id":{"description":"SVX Verify session identifier.","type":"string","format":"uuid"},"status":{"description":"Current state of the presentation request processing.","type":"string","enum":["pending","pending-loaded","completed"]},"error":{"description":"Error code returned while the request is still pending.","type":["string","null"]},"error_description":{"description":"Human-readable description for the current error, when present.","type":["string","null"]}},"required":["id","status","error","error_description"],"type":"object"},"ForbiddenError":{"properties":{"error":{"description":"Unique error identifier","enum":["forbidden"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"SessionNotFoundError":{"properties":{"error":{"description":"Unique error identifier","enum":["session_not_found"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"SessionExpiredError":{"properties":{"error":{"description":"Unique error identifier","enum":["session_expired"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"InternalServerError":{"properties":{"error":{"description":"Unique error identifier","enum":["internal_server_error"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"}}}}
```

## Accept SVX Verify terms

> Mark the verification session's terms and conditions as accepted for the current SVX Verify flow.\
> Intended to be called from the hosted verification UI; this operation typically requires the session cookie established during the browser-based flow.<br>

```json
{"openapi":"3.1.0","info":{"title":"SVX Wallet API","version":"4.0.1"},"servers":[{"url":"https://zyfla-wallet-sandbox.meeco.cloud","description":"SVX Wallet deployment (relative)"}],"security":[],"paths":{"/verify/verification/{id}/accept_terms":{"post":{"summary":"Accept SVX Verify terms","description":"Mark the verification session's terms and conditions as accepted for the current SVX Verify flow.\nIntended to be called from the hosted verification UI; this operation typically requires the session cookie established during the browser-based flow.\n","operationId":"VerificationController_acceptTerms","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false}}},"description":"Terms accepted"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SessionNotFoundError"},{"$ref":"#/components/schemas/SessionExpiredError"}]}}},"description":""},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":""}},"tags":["SVX Verify"]}}},"components":{"schemas":{"ForbiddenError":{"properties":{"error":{"description":"Unique error identifier","enum":["forbidden"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"SessionNotFoundError":{"properties":{"error":{"description":"Unique error identifier","enum":["session_not_found"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"SessionExpiredError":{"properties":{"error":{"description":"Unique error identifier","enum":["session_expired"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"},"InternalServerError":{"properties":{"error":{"description":"Unique error identifier","enum":["internal_server_error"],"type":"string"},"extra_info":{"description":"Object that may contain more information about the error","type":"object"},"message":{"description":"User friendly error message","type":"string"}},"required":["error","message","extra_info"],"type":"object"}}}}
```