> ## Documentation Index
> Fetch the complete documentation index at: https://docs.idmetagroup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate Trust Flow Link

> Generate a Trust Flow link that can be shared with an applicant to complete a verification flow.



## OpenAPI

````yaml api-reference/openapi.json POST /api/v3/trustflows/generate-link
openapi: 3.0.3
info:
  title: IDmeta API
  description: IDmeta verification and integration API.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://{environment-subdomain}.idmetagroup.com
    description: Your environment (replace `{environment-subdomain}`)
    variables:
      environment-subdomain:
        default: integrate
        description: IDmeta environment subdomain
security:
  - bearerAuth: []
tags:
  - name: Processes
    description: Verification process endpoints
  - name: Trust Flow Links
    description: Trust Flow link generation endpoints
  - name: Compliance
    description: Compliance verification endpoints
  - name: Government Data
    description: Government data verification endpoints
  - name: Alternative Verifications
    description: Alternative verification and intelligence endpoints
  - name: OCR
    description: Document OCR extraction endpoints
paths:
  /api/v3/trustflows/generate-link:
    post:
      tags:
        - Trust Flow Links
      summary: Generate Trust Flow Link
      description: >-
        Generate a Trust Flow link that can be shared with an applicant to
        complete a verification flow.


        **Link types:**

        - `1` — Single-use link. Only one verification can be completed with
        this link. `expiry` is optional.

        - `2` — Time-use link. The link can be reused multiple times until it
        reaches its expiry time. `expiry` is required.


        The `type` field must be an integer. String values such as `single_use`
        or `time_use` are not supported.
      operationId: generateTrustFlowLinkV3
      parameters:
        - name: Accept
          in: header
          required: false
          schema:
            type: string
            default: application/json
        - name: Content-Type
          in: header
          required: false
          schema:
            type: string
            default: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateTrustFlowLinkRequest'
            examples:
              default:
                summary: Generate Trust Flow Link request
                value:
                  type: 1
                  trustFlowId: 0
                  expiry: '2026-06-20T08:00:00Z'
                  metadata: accid:112233,transactionId:aabb-1234-000
              timeLimited:
                summary: Time-limited link
                value:
                  type: 2
                  trustFlowId: 147
                  expiry: '2026-06-20T08:00:00Z'
              timeLimitedWithMetadata:
                summary: Time-limited link with metadata
                value:
                  type: 2
                  trustFlowId: 147
                  expiry: '2026-06-20T08:00:00Z'
                  metadata: accid:112233,transactionId:aabb-1234-000
      responses:
        '200':
          description: Trust Flow link generated successfully
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateTrustFlowLinkResponse'
              example:
                success: true
                link: >-
                  https://web-sdk.idmetagroup.com/v/e1fc9069-06e2-4713-ba79-30ab12795450?m=accid:112233,transactionId:aabb-1234-000
components:
  schemas:
    GenerateTrustFlowLinkRequest:
      type: object
      required:
        - type
        - trustFlowId
      properties:
        type:
          type: integer
          default: 1
          description: >-
            Trust Flow link type. Use `1` for a single-use link. Only one
            verification can be completed with this link. Use `2` for a time-use
            link. The link can be reused multiple times until it reaches its
            expiry time. Must be an integer — string values such as `single_use`
            or `time_use` are not supported.
        trustFlowId:
          type: integer
          description: Trust Flow ID used to generate the link.
        expiry:
          type: string
          format: date-time
          description: >-
            Expiry date and time in ISO 8601 format, including timezone offset.
            Required when `type` is `2`. Optional when `type` is `1`. Example:
            `2026-06-20T16:00:00+08:00`.
        metadata:
          type: string
          description: >-
            Optional custom key-value data appended to the generated URL as the
            `m` query parameter. Example:
            `accid:112233,transactionId:aabb-1234-000`.
    GenerateTrustFlowLinkResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the link was generated successfully.
        link:
          type: string
          description: Full generated Trust Flow link.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use `Bearer {your_api_token}` in the Authorization header.

````