> ## Documentation Index > Fetch the complete documentation index at: https://docs.oms.verolabs.co/llms.txt > Use this file to discover all available pages before exploring further. # Send or verify a recovery code > Send or verify a recovery code ## OpenAPI ````yaml openapi.docs.en.json POST /api/authen/self-service/recovery openapi: 3.0.3 info: title: Vero OMS REST API version: 1.0.24 description: >- REST API documentation for Vero OMS. Paths are aligned with the active KrakenD gateway config under k8s-dev-gitops/vero-algo/tools/krakend and response schemas are expanded from backend/frontend source models. servers: - url: https://api-gw.verolabs.co description: API gateway security: [] tags: - name: Auth description: Authentication flows and app logout - name: Signup description: APIs used during account signup - name: Accounts description: User accounts, balances, positions, deposits and withdrawals - name: Bank Accounts description: Saved bank account management - name: Orders description: Order placement, cancellation, modification and order history - name: History description: Account orders, trades and cash transactions. - name: Market Data description: Watchlists, symbol search, product master and OHLCV history - name: Notifications description: In-app notifications - name: Referral description: Referral code, rebate and commission summary APIs - name: Diagnostics description: Health and diagnostic endpoints paths: /api/authen/self-service/recovery: post: tags: - Auth summary: Send or verify a recovery code operationId: updateRecoveryFlow parameters: - $ref: '#/components/parameters/Flow' requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/RecoveryCodeRequest' - $ref: '#/components/schemas/RecoveryVerifyRequest' description: >- self-service flow update payload. Pass the flow id in the query string and include the fields required by the selected method. responses: '200': description: >- Recovery flow updated. A passed challenge can return session_token directly or continue_with instructions that include set_session_token. content: application/json: schema: $ref: '#/components/schemas/RecoveryResponse' '400': $ref: '#/components/responses/AuthFlowError' description: Error response. content: application/json: schema: $ref: '#/components/schemas/AnyErrorBody' application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' text/plain: schema: type: string description: Plain-text backend or gateway error message. '401': $ref: '#/components/responses/ErrorResponse' description: Error response. content: application/json: schema: $ref: '#/components/schemas/AnyErrorBody' application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' text/plain: schema: type: string description: Plain-text backend or gateway error message. '404': $ref: '#/components/responses/ErrorResponse' description: Error response. content: application/json: schema: $ref: '#/components/schemas/AnyErrorBody' application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' text/plain: schema: type: string description: Plain-text backend or gateway error message. '500': $ref: '#/components/responses/ErrorResponse' description: Error response. content: application/json: schema: $ref: '#/components/schemas/AnyErrorBody' application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' text/plain: schema: type: string description: Plain-text backend or gateway error message. default: $ref: '#/components/responses/Error' description: Error response. content: application/json: schema: $ref: '#/components/schemas/AnyErrorBody' application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' text/plain: schema: type: string description: Plain-text backend or gateway error message. security: [] components: parameters: Flow: name: flow in: query required: true schema: type: string description: >- Flow identifier returned by the matching create-flow endpoint. Submit/update requests must use the same flow id. schemas: RecoveryCodeRequest: type: object required: - method - email properties: method: type: string enum: - code description: Recovery method. Use code for email code recovery. email: type: string format: email description: Email address that should receive the recovery code. description: >- Payload used to request a recovery code for the email address on an recovery flow. RecoveryVerifyRequest: type: object required: - method - code properties: method: type: string enum: - code description: Recovery method. Use code for email code recovery. code: type: string description: One-time recovery code received by the user. description: Payload used to verify the recovery code on an recovery flow. RecoveryResponse: allOf: - $ref: '#/components/schemas/AuthFlow' - type: object properties: session_token: type: string description: >- Session token returned after successful recovery verification, when issued directly. continue_with: type: array items: type: object additionalProperties: true description: >- Follow-up actions returned by the system, such as set_session_token instructions. description: >- Updated recovery flow response. Successful verification can include session_token or continue_with instructions. AnyErrorBody: oneOf: - $ref: '#/components/schemas/ErrorResponse' - $ref: '#/components/schemas/ValidationProblemDetails' - $ref: '#/components/schemas/ProblemDetails' - $ref: '#/components/schemas/AuthFlow' description: >- Structured error body returned by gateway, ASP.NET services, or backend validation handlers. ValidationProblemDetails: allOf: - $ref: '#/components/schemas/ProblemDetails' - type: object additionalProperties: true properties: errors: type: object additionalProperties: oneOf: - type: array items: type: string - type: string description: Validation errors keyed by request field name. description: >- Validation problem response returned when request parameters or body fields are invalid. ProblemDetails: type: object additionalProperties: true description: RFC 7807-style problem response returned by ASP.NET/gateway services. properties: type: type: string description: Problem type URI. title: type: string description: Short problem title. status: type: integer description: HTTP status code. detail: type: string description: Detailed error message. traceId: type: string description: Trace id for backend diagnostics. AuthFlow: type: object additionalProperties: true properties: id: type: string description: >- Flow id. Use this value as the flow query parameter when submitting or updating the flow. type: type: string description: Flow type returned by the system, for example browser or api. expires_at: type: string format: date-time description: Timestamp when the flow expires. Submit the flow before this time. issued_at: type: string format: date-time description: Timestamp when created the flow. ui: type: object additionalProperties: true description: >- UI payload containing action URL, method, nodes, messages, and CSRF node when required. state: type: string description: >- Current flow state, such as choose_method, sent_email, passed_challenge, or success. request_url: type: string description: Original request URL used to create the flow. organization_id: type: string nullable: true description: organization id for organization-scoped flows, when supplied. created_at: type: string description: Flow creation timestamp. format: date-time updated_at: type: string description: Flow update timestamp. format: date-time refresh: type: boolean description: Whether the flow is a refresh flow. requested_aal: type: string description: Requested authenticator assurance level for the flow. identity: allOf: - 9cb587e8-c15a-435c-916a-4854d0ffa2c6 description: Identity attached to settings flows when the system includes it. description: >- self-service flow object returned by login, registration, recovery, and settings create/update endpoints. ErrorResponse: type: object additionalProperties: true description: >- Error body returned by gateway or backend services. Backends can return either JSON objects or plain text errors. properties: error: oneOf: - type: string - type: object additionalProperties: true properties: id: type: string description: gateway error id when supplied. code: type: integer description: HTTP-like error code. status: type: string description: HTTP status text, for example Unauthorized. reason: type: string description: >- Detailed reason returned by the authentication service or gateway. message: type: string description: Human-readable error message. description: Error code/message string or nested gateway error object. message: type: string description: Human-readable error message. detail: type: string description: Detailed backend error message when available. details: oneOf: - type: string - type: object additionalProperties: true - type: array items: type: object additionalProperties: true description: Additional validation or backend details. nullable: true status: type: integer description: HTTP status code when included by the backend. responses: AuthFlowError: description: Authentication flow validation error. content: application/json: schema: $ref: '#/components/schemas/AuthFlow' ErrorResponse: description: Error response containing an error code, message, detail, or plain text. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' text/plain: schema: type: string Error: description: Error response. The app reads detail or message when available. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' text/plain: schema: type: string ````