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

# Get notification platforms

> Returns the active notification channels (e.g. email, WhatsApp). Use a channel's `id` as `notificationPlatformId` when creating a session to have Cr3dentials send the verification link to your applicant.



## OpenAPI

````yaml /api-reference/openapi.json get /partner/notification-platforms
openapi: 3.1.0
info:
  title: Cr3dentials Partner API
  description: >-
    Integrate account verification into your application. Users verify their
    accounts through an iframe-based browser session, and you receive
    cryptographically attested proof of data authenticity.
  version: 1.0.0
  contact:
    name: Cr3dentials Support
    url: https://cr3dentials.xyz
servers:
  - url: https://app.cr3dentials.xyz/v1
    description: Production
  - url: https://staging.cr3dentials.xyz/v1
    description: Staging
security:
  - apiKey: []
paths:
  /partner/notification-platforms:
    get:
      tags:
        - Platforms
      summary: Get notification platforms
      description: >-
        Returns the active notification channels (e.g. email, WhatsApp). Use a
        channel's `id` as `notificationPlatformId` when creating a session to
        have Cr3dentials send the verification link to your applicant.
      operationId: getNotificationPlatforms
      responses:
        '200':
          description: List of notification platforms
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotificationPlatform'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    NotificationPlatform:
      type: object
      properties:
        id:
          type: integer
          description: Channel identifier (use as `notificationPlatformId`).
          example: 1
        name:
          type: string
          example: email
        displayName:
          type: string
          example: Email
        description:
          type:
            - string
            - 'null'
          example: Send the verification link by email
        icon:
          type:
            - string
            - 'null'
          example: https://cdn.cr3dentials.xyz/icons/email.png
        isActive:
          type: boolean
          example: true
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          example:
            statusCode: 401
            message: Unauthorized
    RateLimited:
      description: Too many requests — 120 req / 60s per API key. Use exponential backoff.
      content:
        application/json:
          example:
            statusCode: 429
            message: Too Many Requests
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: 'Your partner API key. Alternatively, pass `Authorization: Bearer <key>`.'

````