Receeve Landing Page API

openapi: 3.2.0
info:
  title: InDebted Receive API Documentation Landing Page API
  description: 'This is the API definition for interacting with InDebted''s Receive debt servicing platform. For more details please visit the Integration Documentation.


    **Using this spec in code generators, Postman, or other tooling?** Fetch the raw document at https://receive-api.indebted.co/openapi/apiSchema.yaml — that is the canonical OpenAPI file. Prefer it over the in-page download button, which re-serialises the document and can alter value types (e.g. date-formatted strings).'
  contact:
    email: techteam@indebted.co
  version: 1.53.1
servers:
- url: /
  description: API base path
tags:
- name: Landing Page
  description: The Landing Page of the Debtor, used to display, pay the Claims (or other use cases).
paths:
  /v1/{clientId}/get_landing_page_url:
    get:
      tags:
      - Landing Page
      summary: Get Landing Page URL
      operationId: getLandingPageURL
      parameters:
      - $ref: '#/components/parameters/ClientIdParameter'
      - $ref: '#/components/parameters/AuthorizationParameter'
      - $ref: '#/components/parameters/ClaimReferenceParameter'
      - $ref: '#/components/parameters/TriggerNameParameter'
      responses:
        '200':
          $ref: '#/components/responses/200SuccessGetLandingPageURL'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '429':
          $ref: '#/components/responses/429LimitsReached'
        '500':
          $ref: '#/components/responses/500InternalError'
      security:
      - api_key: []
components:
  parameters:
    AuthorizationParameter:
      in: header
      name: Authorization
      required: true
      description: 'OAuth2 Token (obtained from /oauth2/token )

        Reference: https://docs.indebted.co/docs/receive/integration/use-cases/authentication-use-case

        '
      example: Bearer <access_token>
      schema:
        type: string
    TriggerNameParameter:
      name: triggerName
      in: query
      required: false
      description: This is name of Custom Trigger that should be triggered when this API is called.
      schema:
        type: string
      example: customTrigger1
    ClaimReferenceParameter:
      name: claimReference
      in: query
      required: true
      example: ACCOUNT_REFERENCE_002
      description: Receive Claim Reference
      schema:
        type: string
        minLength: 1
    ClientIdParameter:
      name: clientId
      in: path
      required: true
      description: 'A Receive system identifier that will be assigned automatically.

        It will be used for situations like Support related interventions or data segmentation.

        '
      example: ec702157-705b-42a0-b70e-a60a63dd24ab
      schema:
        type: string
        format: uuid
  responses:
    401Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthorized
    400BadRequest:
      description: Incorrectly formed request
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: 'Missing required request parameters: [Authorization]'
    500InternalError:
      description: Internal error occured
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Internal error
    429LimitsReached:
      description: Request was throttled
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Too Many Requests
    403Forbidden:
      description: Access is denied
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Forbidden
    200SuccessGetLandingPageURL:
      description: Request for get_landing_page_url is successful
      content:
        application/json:
          schema:
            type: object
            required:
            - URL
            properties:
              URL:
                type: string
                description: URL of Landing Page
                example: https://domain.com/c/btXXskwXX
          example:
            URL: https://domain.com/c/btXXskwXX
    404NotFound:
      description: Not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Not found
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header