Headers

• x-fapi-auth-date string

  The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

  Format should match the following pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$.

• x-fapi-customer-ip-address string

  The PSU's IP address if the PSU is currently logged in with the TPP.

• x-fapi-interaction-id string

  An RFC4122 UID used as a correlation id.

• x-customer-user-agent string

  Indicates the user-agent that the PSU is using.

Query parameters

• page integer

  The page number to return of the result set

• size integer

  The size of the pages to return

• sort string

  The field name to sort

• displayMine string

  Set to an email value to instruct the backend to only return organisations related to the user

• filterBy string

  Will return organisations with data like the provided value

• hideInactive boolean

  Will return only active organisations

Responses

• 200 application/json

  All organisations

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  Hide response attributes Show response attributes object

  • content array[object]
    Hide content attributes Show content attributes object

    • AddressLine1 string

      Address line 1

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • AddressLine2 string

      Address line 2

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • City string

      City

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • CompanyRegister string

      Legal company register for the country, i.e. Companies House

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • Country string

      Country

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • CountryOfRegistration string

      Country of registration for the org

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • CreatedOn string

      JSONDatetime of organisation creation.

      Maximum length is 30.

    • Flags array[object]
      Hide Flags attributes Show Flags attributes object

      • CreatedAt string(date-time)
      • Id string

        Unique ID of the flag

        Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

      • UpdatedAt string(date-time)
      • AccessLevel integer Required

        The access level of a flag as a number. The higher the number, the more sensitive it is

      • Description string

        The description of this flag

        Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

      • Name string Required

        The name of this flag

        Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

      • Status string Required

        Current status of this resource

        Values are Active or Inactive. Default value is Active.

      • Type string Required

        The type of this tag

        Values are Organisation, Software_Statement, or Authorisation_Server.

      • Value string Required

        The value of this flag

        Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • LegalEntityName string

      Legal Entity name for the org. Usually the same as org name

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • LogoUri string(uri)

      A compliant URI

      Format should match the following pattern: ^(http://|https://).*.(svg|png|jpg|jpeg)$|(data:image/[a-zA-Z0-9;+=-]+,[A-Za-z0-9+/]*={0,2})$.

    • OrganisationId string

      Unique ID associated with the organisation

      Minimum length is 1, maximum length is 40. Format should match the following pattern: ^[^<>]*$.

    • OrganisationName string

      Name of the organisation.

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • ParentOrganisationReference string

      Parent Organisation Reference

      Maximum length is 65535. Format should match the following pattern: ^[^<>]*$.

    • Postcode string

      Postcode

      Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

    • RegisteredName string

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • RegistrationId string

      Registered ID for the organisation i.e. Legal Entity identifier number

      Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

    • RegistrationNumber string

      Company registration number from company register i.e. Companies House registration number

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • RequiresParticipantTermsAndConditionsSigning boolean

      true - this organisation requires terms and conditions to be signed. false - this organisation does not require terms and conditions to be signed

    • Size string

      Size of the organisation

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • Status string

      Status of the directory registration of an organisation

      Values are Active, Pending, or Withdrawn. Default value is Active.

  • empty boolean
  • numberOfElements integer
  • offset integer
  • pageNumber integer
  • pageable object
    Hide pageable attributes Show pageable attributes object

    • number integer

      Page number

    • offset integer

      Offset

    • size integer

      Size of the page

    • sort object
      Hide sort attributes Show sort attributes object

      • orderBy array[object]
        Hide orderBy attributes Show orderBy attributes object

        • ascending boolean

          Whether ascending

        • direction string

          Direction of sort, i.e. ascending or descending

          Values are ASC or DESC.

        • ignoreCase boolean

          Was the case ignored

        • property string

          Name of the property used for sorting

      • sorted boolean
    • sorted boolean

      Is the page sorted

    • unpaged boolean

      Is this an unpaged response

  • size integer
  • totalPages integer
  • totalSize integer
• 401

  Unauthorized

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 403

  Forbidden

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 404 application/json

  Not found

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  Hide response attribute Show response attribute object

  • errors array[string]

    Validation Error messages

• 406

  Not Acceptable

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 429

  Too many requests, maximum capacity reached. Requests are now throttled.

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 500

  Internal Server Error

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 502

  Bad Gateway

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

• 504

  Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.

  Hide headers attribute Show headers attribute

  • x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.