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.

Path parameters

• OrganisationId string Required

  The organisation ID

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

• OrganisationAuthorityClaimId string(uuid) Required

  The Authority claims ID for an organisation

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

Responses

• 200 application/json

  A given organisation authority domain role claim with additional details

  Hide response attributes Show response attributes object

  • AuthorisationDomain string Deprecated

    Authorisation domain name. Deprecated in favour of providing the ID. Note, when fully deprecated, will still be returned in the response object

    Format should match the following pattern: ^[^<>]*$.

  • AuthorisationDomainID string(uuid)

    Unique identifier for an authorisation domain

  • AuthorisationDomainRoleIdentifier string(uuid)

    Unique identifier for an authorisation domain role

  • AuthorityId string(uuid) Required

    Unique ID associated with the Authorisation reference schema

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

  • RegistrationId string

    Registration ID for the organisation

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

  • Role string Deprecated

    Authorisation domain role name. Deprecated in favour of providing the ID. Note, when fully deprecated, will still be returned in the response object

    Format should match the following pattern: ^[^<>]*$.

  • UniqueTechnicalIdentifiers array[string]

    Not more than 16 elements. Maximum length of each is 255. Format of each should match the following pattern: ^[^<>]*$.

  • Status string Required

    Current status of this resource

    Values are Active or Inactive. Default value is Active.

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

    • MemberState string

      Abbreviated states information i.e. GB, IE, NL etc

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

    • Status string

      Current status of this resource

      Values are Active or Inactive. Default value is Active.

  • Exclusive boolean

    An organization that claims an exclusive role cannot claim any other roles

  • Metadata object

    Authorisation domain role metadata

  • OrganisationAuthorityClaimId string(uuid)

    Unique ID associated with an organisation authority domain role claim

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

  • OrganisationId string

    Unique ID associated with the organisation

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

  • RoleType string

    Type of authorisation domain role

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

• 400 application/json

  Bad Request

  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

• 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}$.