Get a Software Statement Assertion for Given SoftwareStatementID

GET 
/organisations/:OrganisationId/softwarestatements/:SoftwareStatementId/assertion

The response body is a signed JWT and the values found in the header and the payload of the SSA are specified below

Request

Path Parameters

OrganisationId OrganisationIdrequired

Possible values: non-empty and <= 40 characters

The organisation ID

SoftwareStatementId SoftwareStatementIdrequired

Possible values: <= 40 characters

The software statement ID

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

200

OK

Response Headers

• x-fapi-interaction-id

  string

application/jwt

Schema

Schema

string

Possible values: <= 4000 characters

application/json

Schema

Schema

software_mode string

Possible values: <= 8 characters, [Live, Test]

Default value: Live

Software Statement mode

software_redirect_uris string[]

redirect_uris uri must be provided. For client_credentials this should be an empty array.

software_api_webhook_uris string[]
software_origin_uris string[]
software_statement_roles array
software_client_name string

Possible values: <= 255 characters

Software Statement client name

org_status string

Possible values: [Active, Pending, Withdrawn]

Status of the directory registration of an organisation

software_client_id string

Possible values: <= 255 characters

Software Statement client Id

iss string

SSA Issuer

software_tos_uri uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

The Software Statement terms of service compliant URI

software_client_description string

Possible values: <= 255 characters

Human-readable detailed description of the client

software_jwks_uri string

Possible values: <= 255 characters

Contains all active signing and network certs for the software

software_jwks_transport_uri string
org_jwks_uri string

Possible values: <= 256 characters

Contains all active signing and network certs for the organisation

org_jwks_transport_uri string
software_policy_uri uri

Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

A compliant URI string that points to a human-readable privacy policy document

software_id string

Unique Identifier for Client Software

software_client_uri string

Possible values: <= 255 characters

The website or resource root uri returned if the Trust Framework is of Non Federated Type.

software_on_behalf_of_org string

Possible values: <= 40 characters

A reference to fourth party organisation resource on the Directory if the registering app is acting on behalf of another

software_logo_uri string

Possible values: <= 256 characters

Link to the Org logo

org_id string

Possible values: non-empty and <= 40 characters

The Unique Organisation Id

software_jwks_inactive_uri string
software_jwks_transport_inactive_uri string
org_jwks_inactive_uri string
org_jwks_transport_inactive_uri string
software_environment string

Possible values: <= 255 characters

Requested additional field to avoid certificate check

software_version string

The version number of the software should an org choose to register and / or maintain it

software_roles string[]
org_name string

Possible values: <= 140 characters

Legal Entity Identifier or other known organisation name

org_number string
software_status string

Included to cater for voluntary withdrawal from directory scenarios|Active, Revoked, or Withdrawn

organisation_competent_authority_claims string[]

Claims object for the organisation detailing all the authorisation roles

software_sector_identifier_uri string
organisation_flags string[]
organisation_tags string[]
software_flags string[]

400

Bad Request

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

errors string[]

Validation Error messages

Example (from schema)

{
  "errors": [
    "string"
  ]
}

401

Unauthorized

Response Headers

• x-fapi-interaction-id

  string

403

Forbidden

Response Headers

• x-fapi-interaction-id

  string

429

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

Response Headers

• x-fapi-interaction-id

  string

500

Internal Server Error

Response Headers

• x-fapi-interaction-id

  string

502

Bad Gateway

Response Headers

• x-fapi-interaction-id

  string

504

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

Response Headers

• x-fapi-interaction-id

  string

Loading...