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: ^[^<>]*$.

• AuthorisationServerId string Required

  The authorisation server Id

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

• ApiResourceId string Required

  The api version Id

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

Responses

• 200 application/json

  Authorisation server Api Resource response

  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

  • ApiCertificationUri string(uri)

    Link to the certifation package. Example https://github.com/Open[Domain]/conformance/blob/main/submissions/functional/business/1.0.3/api-business-customer.zip

    Maximum length is 500. Format should match the following pattern: ^(https://).*.

  • ApiFamilyType string

    The type of API this record describes

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

  • ApiResourceId string

    The unique ID of an Api version resource

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

  • ApiVersion string

    The version number of the API

    Format should match the following pattern: ^([0-9]+\.[0-9]+\.[0-9]+)$|^([0-9]+)$.

  • CertificationExpirationDate string

    JSONDatetime of certification expiration date

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

  • CertificationStartDate string

    JSONDatetime of certification start date

    Format should match the following pattern: ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$.

  • CertificationStatus string

    The different types of certification status

    Values are Awaiting Certification, Certified, Deprecated, Rejected, Warning, or Self-Certified. Default value is Awaiting Certification.

  • FamilyComplete boolean

    Denotes whether or not the api resource has had all related api endpoints published

  • Status string

    Current status of this resource

    Values are Active or Inactive. Default value is Active.

• 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

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