Skip to main content

Reference Data of all authorities

GET 
/references/authorities

get all authorities

Request​

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

    authorityName string

    Will return authorities with names similar to the provided authorityName

    authorityCountry string

    Will return authorities with countries similar to the provided authorityCountry

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(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)$

    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

    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.

Responses​

Reference data table for all authorities with their countries

Response Headers

  • x-fapi-interaction-id

    string

Schema

    content

    object[]

  • Array [

    • AuthorityId AuthorityId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the Authorisation reference schema

    AuthorityName string

    Possible values: <= 255 characters

    Name of the Authority i.e. FCA, etc

    AuthorityCode string

    Possible values: <= 40 characters

    Code of the Authority i.e. FCA, etc

    AuthorityUri string

    Possible values: Value must match regular expression ^[^<>]*$

    URI of the authority

    AuthorityCountry string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    country of the Authority

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

  • ]

    • totalPages integer
    totalSize integer

    pageable

    object

    number integer

    Page number

    sort

    object

    sorted boolean

    orderBy

    object[]

  • Array [

    • property string

    Name of the property used for sorting

    direction string

    Possible values: [ASC, DESC]

    Direction of sort, i.e. ascending or descending

    ignoreCase boolean

    Was the case ignored

    ascending boolean

    Whether ascending

  • ]

    • size integer

    Size of the page

    offset integer

    Offset

    sorted boolean

    Is the page sorted

    unpaged boolean

    Is this an unpaged response

    numberOfElements integer
    size integer
    offset integer
    empty boolean
    pageNumber integer
Loading...