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

# Request a patient portal OTP

> Requests a one-time code for the patient phone number. Use the country code and phone fields supplied for your integration.



## OpenAPI

````yaml /openapi/nimbo_patient_portal.yml post /api/v1/patient_portal/auth
openapi: 3.1.0
info:
  title: Nimbo patient portal
  version: 1.0.0
  description: >-
    Nimbo API reference. Use the API host and integration access provided by
    Nimbo.
servers:
  - url: https://api.example.test
security: []
tags:
  - name: Patient Portal
  - name: Patient portal authentication
paths:
  /api/v1/patient_portal/auth:
    post:
      tags:
        - Patient portal authentication
      summary: Request a patient portal OTP
      description: >-
        Requests a one-time code for the patient phone number. Use the country
        code and phone fields supplied for your integration.
      operationId: customerPatientPortalAuth
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                country_code:
                  type: string
                phone:
                  type: string
      responses:
        '200':
          description: The request succeeded.
      security: []

````