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

# Get Create Account URL

<Warning>
  **This API MUST be implemented by the Partner.** Platform's backend will consume it to obtain the delegated registration link.
</Warning>

Our backend will consume this service by performing a `POST` request to:

`[Base-URL]/GetCreateAccountUrl`.

This endpoint will only be used when the Partner has account creation configured as `OnDemand`.

**Expected behavior:**
Invokes the retrieval of a temporary delegated registration URL. In cases where the Partner orchestrates the user account registration, this endpoint must generate and return a secure `RegistrationUrl` where the user can complete or initiate their enrollment.


## OpenAPI

````yaml swagger-client-interfaces.json POST /client-interfaces/pmo/get-create-account-url
openapi: 3.0.0
info:
  title: ''
  version: 0.0.1
servers: []
security: []
paths:
  /client-interfaces/pmo/get-create-account-url:
    post:
      tags:
        - Partner Implemented APIs
      summary: Get create account URL
      operationId: getCreateAccountUrlClientApi
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCreateAccountUrlRequest'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCreateAccountUrlResponse'
      security: []
components:
  schemas:
    GetCreateAccountUrlRequest:
      properties:
        TransactionId:
          type: string
        PersonalData:
          $ref: '#/components/schemas/PersonalData'
        PersonalDocuments:
          items:
            $ref: '#/components/schemas/PersonalDocument'
          type: array
      required:
        - TransactionId
        - PersonalData
      type: object
      additionalProperties: false
    GetCreateAccountUrlResponse:
      properties:
        RegistrationUrl:
          type: string
        Success:
          type: boolean
        ResponseDescription:
          type: string
      required:
        - RegistrationUrl
        - Success
        - ResponseDescription
      type: object
      additionalProperties: false
    PersonalData:
      description: >-
        Personal information. At least one of `PhoneNumber` or `Email` must be
        provided.
      properties:
        PhoneNumber:
          type: string
          description: User phone number. Required when `Email` is not provided.
        Email:
          type: string
          description: User email address. Required when `PhoneNumber` is not provided.
        FirstName:
          type: string
        MiddleName:
          type: string
        LastName:
          type: string
        LastName2:
          type: string
        Gender:
          type: string
        BirthDate:
          type: string
          description: Date formatted string, e.g. YYYY-MM-DD
        Address:
          $ref: '#/components/schemas/Address'
      required:
        - FirstName
        - LastName
        - Gender
        - BirthDate
        - Address
      type: object
      additionalProperties: false
    PersonalDocument:
      properties:
        Number:
          type: string
        DocumentType:
          $ref: '#/components/schemas/DocumentType'
      required:
        - Number
        - DocumentType
      type: object
      additionalProperties: false
    Address:
      properties:
        Address1:
          type: string
        Address2:
          type: string
        ZipCode:
          type: string
        City:
          type: string
        CountryCode:
          type: string
          description: ISO 3166-2
          minLength: 2
          maxLength: 2
        StateCode:
          type: string
          description: ISO 3166-2
      required:
        - Address1
        - City
        - CountryCode
        - StateCode
      type: object
      additionalProperties: false
    DocumentType:
      type: string
      enum:
        - None
        - Passport
        - StateId
        - ResidentCard
        - DriverLicense
        - SocialSecurityNumber
        - INE_IFE
        - ConsularId
        - ITIN

````