--- title: "Initialize Verification Flow for APIs, Services, Apps, ..." method: GET path: "/self-service/verification/api" tags: ["v0alpha1"] --- # Initialize Verification Flow for APIs, Services, Apps, ... `GET /self-service/verification/api` This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation). ## Response `200` selfServiceVerificationFlow - SelfServiceVerificationFlow — Used to verify an out-of-band communication channel such as an email address or a phone number. For more information head over to: https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation - `active` string — Active, if set, contains the registration method that is being used. It is initially not set. - `expires_at` string, date-time — ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address, a new request has to be initiated. - `id` string, uuid4, required - `issued_at` string, date-time — IssuedAt is the time (UTC) when the request occurred. - `request_url` string — RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. - `state` 'choose_method' | 'sent_email' | 'passed_challenge', required — The state represents the state of the verification flow. choose_method: ask the user to choose a method (e.g. recover account via email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the recovery challenge was passed. - `type` string, required — The flow type can either be `api` or `browser`. - `ui` UiContainer, required — Container represents a HTML Form. The container can work with both HTTP Form and JSON requests - `action` string, required — Action should be used as the form action URL `
`. - `messages` UiText[] - `context` object — The message's context. Useful when customizing messages. - `id` integer, required - `text` string, required — The message text. Written in american english. - `type` string, required - `method` string, required — Method is the form method (e.g. POST) - `nodes` UiNode[], required - `attributes` union, required - UiNodeInputAttributes — InputAttributes represents the attributes of an input node - `disabled` boolean, required — Sets the input's disabled field to true or false. - `label` UiText - `context` object — The message's context. Useful when customizing messages. - `id` integer, required - `text` string, required — The message text. Written in american english. - `type` string, required - `name` string, required — The input's element name. - `pattern` string — The input's pattern. - `required` boolean — Mark this input field as required. - `type` string, required - `value` unknown - UiNodeTextAttributes - `text` UiText, required - `context` object — The message's context. Useful when customizing messages. - `id` integer, required - `text` string, required — The message text. Written in american english. - `type` string, required - UiNodeImageAttributes - `src` string, required — The image's source URL. format: uri - UiNodeAnchorAttributes - `href` string, required — The link's href (destination) URL. format: uri - `title` UiText, required - `context` object — The message's context. Useful when customizing messages. - `id` integer, required - `text` string, required — The message text. Written in american english. - `type` string, required - `group` string, required - `messages` UiText[], required - `context` object — The message's context. Useful when customizing messages. - `id` integer, required - `text` string, required — The message text. Written in american english. - `type` string, required - `meta` Meta, required — This might include a label and other information that can optionally be used to render UIs. - `label` UiText - `context` object — The message's context. Useful when customizing messages. - `id` integer, required - `text` string, required — The message text. Written in american english. - `type` string, required - `type` string, required ## Other responses - `400` — jsonError - `500` — jsonError ## Changes - **2021-07-13** `8f1b399ab6e6` — 1 breaking, 3 warning, 4 info - the response property `ui/nodes/items/attributes/oneOf[#/components/schemas/uiNodeInputAttributes]/value` became nullable for the status `200` - added the new `choose_method` enum value to the `state` response property for the response status `200` - added the new `passed_challenge` enum value to the `state` response property for the response status `200` - added the new `sent_email` enum value to the `state` response property for the response status `200` - …4 more - **2021-05-18** `9123bcead5ed` — 5 info - api operation id `initializeSelfServiceVerificationViaAPIFlow` removed and replaced with `initializeSelfServiceVerificationForNativeApps` - the response property `error` became required for the status `400` - the response property `error` became required for the status `500` - the response property `error/message` became required for the status `400` - …1 more - …earlier changes not shown [Full history](https://skmtc.dev/ory/apis/ory-identities-api/changes/self-service/verification/api/get.md) --- [API](https://skmtc.dev/ory/apis/ory-identities-api.md) · [All operations](https://skmtc.dev/ory/apis/ory-identities-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ory/ory-identities-api/revisions/071bec03ddcd/schema)