> ## Documentation Index > Fetch the complete documentation index at: https://docs.privue.ai/llms.txt > Use this file to discover all available pages before exploring further. # Hand off a signed-in user > Open the journey for a user your own app has already signed in. This is the second of the two ways into a journey, for users who arrive from inside your own app, in an in-app browser or a webview. Asking them for their mobile number there would ask them to prove what your app already knows, so a handoff signs them in as this verification's user and lands them on their next step. The record's `journey_url` is the other way in, for every channel where you send a link rather than open one. A handoff is single use and short lived. Create one at the moment you open the browser rather than in advance. While that browser keeps its site storage the user stays signed in, so one handoff carries the whole visit and a new one is only needed for a new browser. Once it has been used, or once `expires_in_seconds` has passed, it stops signing anyone in and the user is asked for their mobile number instead, so a handoff that arrives late costs a sign-in and not the journey. Your API key stays on your server: your app asks your backend for the handoff, and your backend asks us. ## OpenAPI ````yaml /verification/api-reference/openapi.json post /verifications/{verification_id}/handoff openapi: 3.1.0 info: title: Verify with Privue description: >- Start identity-and-business verifications and read the results. There are three ways to run one, and a verification reads the same whichever it was. Every workflow declares which it is for as its `mode`, and a workflow is one of them and never more. **Hosted.** You create a verification with the user's mobile number and receive a journey URL to hand to them. They work through the steps your workflow configures, on our screens, and submit. Use this when the person being verified is reachable and holds their own documents. **Staged.** You create a verification, upload each document you hold against the step it answers, and ask for the checks to run. They take longer than a request should be held open, so you read the result from a callback or by polling. Use this when documents reach you over time, or when you want them kept on the record to download later. **Instant.** You send the whole submission in one request. The checks run before it answers, so the reply is the finished record. The documents are read as they arrive and stored nowhere. Use this when you hold everything already and want the answer in the call you made. Whichever it was, you read the whole record: every step, its state, what it collected, and why anything did not pass. An instant verification hands you that record in its reply; for the other two, poll the verification or register a callback endpoint and be told when it is submitted. Across your whole account you can list the workflows configured for you, count your verifications by status, and page through the records behind a count. Every error response has the shape `{"code": "...", "detail": "..."}`. Branch on `code`: several causes share a status, and `detail` is written for a person reading a log rather than for code. Treat a code you do not recognise as the status it arrived at. version: 0.1.0 servers: - url: https://api.verify.privue.ai description: Production security: [] tags: - name: Workflows description: >- The workflows configured for your account. Read one to see its mode, the documents it asks for, and how each step is answered over the API: the slots its documents go in and the values it takes. - name: Verifications description: >- Starting a verification, ending one, clearing one to run the same subject again, and purging one. Shared by both modes. A start answers 201 when it created the verification and 200 when the subject already had one, so a duplicate is visible from the status code alone. - name: Hosted workflows description: >- For a workflow the person being verified walks themselves. Start a verification with their mobile number, hand them the journey URL on the record, or open it for them from inside your own app with a handoff. - name: Staged workflows description: >- For a workflow you build up from documents you already hold. Upload each file against the step and slot it answers, withdraw one you got wrong, then ask for the checks to run and read the result when they have. Nobody is sent anywhere. - name: Instant workflows description: >- For a workflow answered in the request that asks it. Send the whole submission at once and read the finished record in the reply. Nothing is kept of the documents and nothing is left open to come back to. - name: Results description: >- Reading what a verification came to: one record, a page of them, counts across your account, and links to the files it holds. paths: /verifications/{verification_id}/handoff: post: tags: - Hosted workflows summary: Hand off a signed-in user description: >- Open the journey for a user your own app has already signed in. This is the second of the two ways into a journey, for users who arrive from inside your own app, in an in-app browser or a webview. Asking them for their mobile number there would ask them to prove what your app already knows, so a handoff signs them in as this verification's user and lands them on their next step. The record's `journey_url` is the other way in, for every channel where you send a link rather than open one. A handoff is single use and short lived. Create one at the moment you open the browser rather than in advance. While that browser keeps its site storage the user stays signed in, so one handoff carries the whole visit and a new one is only needed for a new browser. Once it has been used, or once `expires_in_seconds` has passed, it stops signing anyone in and the user is asked for their mobile number instead, so a handoff that arrives late costs a sign-in and not the journey. Your API key stays on your server: your app asks your backend for the handoff, and your backend asks us. operationId: create_handoff_verifications__verification_id__handoff_post parameters: - name: verification_id in: path required: true schema: type: string format: uuid title: Verification Id responses: '200': description: >- A single-use address that opens the journey with the user already signed in. content: application/json: schema: $ref: '#/components/schemas/HandoffResponse' example: url: >- https://verify.privue.ai/acme/merchant-onboarding#ticket=2nR9v6QpKZ8mLxT4bYw1dJhSaEfG7uNc expires_in_seconds: 120 '401': description: |- The API key is missing, malformed, or revoked. The code is `unauthenticated`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: unauthenticated detail: Missing or malformed Authorization header '403': description: >- The workflow belongs to the other environment. An API key is for `uat` or for `production` and reaches only that environment's workflows. Or the key is valid but not enrolled for verifications, or not set up for exactly one of `uat` and `production`, in which case ask us to reissue it. The code is one of `environment-mismatch` or `client-not-enrolled`. content: application/json: example: code: environment-mismatch detail: >- workflow 'merchant-onboarding' is production and this request is for uat schema: $ref: '#/components/schemas/ErrorResponse' '404': description: |- No verification with that id exists on your account. The code is `verification-not-found`. content: application/json: example: code: verification-not-found detail: >- no verification 3f2504e0-4f89-41d3-9a0c-0305e82c3301 for this client schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- The workflow is not hosted, so there is no journey to open; or the verification was cancelled, expired, or failed, or its data has been deleted, so there is no journey left to open. The code is one of `workflow-not-walkable`, `verification-not-open` or `verification-expired`. content: application/json: example: code: workflow-not-walkable detail: the verification is cancelled, so there is no journey to open schema: $ref: '#/components/schemas/ErrorResponse' '422': description: |- An identifier in the path is not in the shape it takes. The code is `request-invalid`. content: application/json: example: code: request-invalid detail: >- verification_id: Input should be a valid UUID, invalid character: found `n` at 1 schema: $ref: '#/components/schemas/ErrorResponse' '429': description: |- The API key is rate limited. Retry after a pause. The code is `rate-limited`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: rate-limited detail: 'Unauthorized: RATE_LIMITED' '503': description: |- API keys could not be checked right now. Retry. The code is `auth-unavailable`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: auth-unavailable detail: Auth provider unavailable security: - HTTPBearer: [] components: schemas: HandoffResponse: properties: url: type: string title: Url description: >- The address to open in the user's browser. The whole URL, fragment included, is a credential: pass it through unchanged and never log, store, or forward it. expires_in_seconds: type: integer title: Expires In Seconds description: How long the handoff stays valid, counted from this response. type: object required: - url - expires_in_seconds title: HandoffResponse description: >- A single-use address that opens the journey with the user already signed in. ErrorResponse: properties: code: $ref: '#/components/schemas/ErrorCode' description: >- What went wrong. Branch on this rather than on the status code, which several causes share, and never on `detail`. Treat a code you do not recognise as the status it arrived at: codes are added as new causes become reachable, and an existing one never changes meaning. detail: type: string title: Detail description: >- What went wrong, in words, naming the workflow, verification, step or field at fault where one is. Written for a person reading a log rather than for code to read, so it is not stable and nothing should be matched against it. type: object required: - code - detail title: ErrorResponse description: The envelope every failure is answered in. ErrorCode: type: string enum: - unauthenticated - client-not-enrolled - rate-limited - auth-unavailable - environment-mismatch - request-invalid - body-unreadable - page-cursor-invalid - window-invalid - request-too-large - not-found - method-not-allowed - internal-error - workflow-not-found - workflow-version-not-found - workflow-not-runnable - workflow-not-walkable - workflow-misconfigured - context-incomplete - context-value-invalid - mobile-required - journey-fields-refused - return-url-not-allowed - reference-taken - verification-not-found - verification-not-open - verification-expired - run-in-progress - credits-exhausted - resets-exhausted - live-limit-reached - step-not-found - step-not-ready - step-invalid - document-not-found - document-not-stored - document-too-large - document-type-not-allowed title: ErrorCode description: >- What went wrong, as a value to branch on. Published vocabulary, stated here rather than shared with any other product of ours: these are read by integrations we do not control, so a name here means what it says for as long as the endpoint answering it exists. One code names one cause, so a status carrying several causes is told apart by the code and never by the message. Codes are added as new causes become reachable; an integration therefore treats an unrecognised code as the status it arrived at. securitySchemes: HTTPBearer: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.