Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• referral_uuid string Required

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • uuid string

    The UUID of the resource.

  • direction string

    The direction of the referral relative to the current firm. Possible values: sent, received

  • connection object

    The referral connection this referral belongs to

    Hide connection attribute Show connection attribute object

    • uuid string
  • clients array[object]

    The original client accounts being referred

    Hide clients attributes Show clients attributes object

    • uuid string
    • name string
  • cloned_clients array[object]

    The cloned client accounts in the recipient firm

    Hide cloned_clients attributes Show cloned_clients attributes object

    • uuid string
    • name string
  • advice_type string

    The type of advice. Possible values: investments, protection, mortgages, estate_planning, other, pensions and tax

  • duration_months integer

    Duration in months (1, 2, 3, or 6). Null for lifetime.

  • shared_data array[string]

    Data categories being shared. Possible values: basic_details, contact_details, income, expenditure, dependants, investments_and_plans, pensions, liabilities, protection, cash_accounts, goals and notes

  • note string

    Additional notes about the referral

  • sla_deadline string

    SLA deadline for recipient to respond

  • status string

    The status of the referral. Possible values: pending, accepted, rejected and expired

  • rejection_reason string

    Reason for rejection (only present if rejected)

  • sender_firm object

    The firm that sent the referral

    Hide sender_firm attributes Show sender_firm attributes object

    • uuid string
    • name string
  • recipient_firm object

    The firm that received the referral

    Hide recipient_firm attributes Show recipient_firm attributes object

    • uuid string
    • name string
  • sender_account object

    The account that sent the referral

    Hide sender_account attributes Show sender_account attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • role string
    • first_name string
    • last_name string
    • name string
    • email string
    • photo_url string
    • external_references object
      Hide external_references attributes Show external_references attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.

  • recipient_account object

    The account that received the referral

    Hide recipient_account attributes Show recipient_account attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • role string
    • first_name string
    • last_name string
    • name string
    • email string
    • photo_url string
    • external_references object
      Hide external_references attributes Show external_references attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.

  • created_at string

    The timestamp of when the resource was created.

  • updated_at string

    The timestamp of when the resource was updated.

  • expires_at string

    The datetime when the referral expires

• 422 application/json

  Validation error

  Hide response attributes Show response attributes object

  • message string Required

    A human-readable description of the error.

  • errors object

    Validation messages keyed by the field that failed.

    Hide errors attribute Show errors attribute object

    • * array[string] Additional properties