Get all data of the given organisation

GET 
/organisations/:OrganisationId/snapshot

returns all data related to a specific organisation

Request

Path Parameters

OrganisationId OrganisationIdrequired

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

The organisation 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

Snapshot data of the organisation

application/json

Schema

Schema

OrganisationDetails

object

OrganisationId OrganisationId (string)

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

Unique ID associated with the organisation

Status string

Possible values: [Active, Pending, Withdrawn]

Default value: Active

Status of the directory registration of an organisation

OrganisationName string

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

Name of the organisation.

CreatedOn string

Possible values: <= 30 characters

JSONDatetime of organisation creation.

LegalEntityName string

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

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

CountryOfRegistration string

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

Country of registration for the org

CompanyRegister string

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

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

Size string

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

Size of the organisation

RegistrationNumber string

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

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

RegistrationId string

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

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

RegisteredName string

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

AddressLine1 string

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

Address line 1

AddressLine2 string

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

Address line 2

City string

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

City

Postcode string

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

Postcode

Country string

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

Country

ParentOrganisationReference string

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

Parent Organisation Reference

RequiresParticipantTermsAndConditionsSigning boolean

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

LogoUri uri

Possible values: Value must match regular expression ^(http://|https://).*.(svg|png|jpg|jpeg)$|(data:image/[a-zA-Z0-9;+=-]+,[A-Za-z0-9+/]*={0,2})$

A compliant URI

Flags

object[]

Array [

Id FlagID (string)

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

Unique ID of the flag

CreatedAt date-time

UpdatedAt date-time

]

Contacts

object[]

The list of contacts

Array [

ContactId string

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

Unique contact ID for the row.

OrganisationId OrganisationId (string)

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

Unique ID associated with the organisation

ContactType ContactType (string)

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

Default value: Business

The type of Contact, default contact type is Business.

FirstName string

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

LastName string

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

Department string

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

EmailAddress string

Possible values: <= 255 characters, Value must match regular expression ^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$

PhoneNumber string

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

AddressLine1 string

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

Address line 1

AddressLine2 string

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

Address line 2

City string

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

City

Postcode string

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

Postcode

Country string

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

Country

AdditionalInformation string

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

Any additional user information

PgpPublicKey string

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

A PGP Public Key in text form

]

AuthorisationServers

object[]

Array [

ApiResources

object[]

Array [

ApiDiscoveryEndpoints

object[]

Array [

ApiDiscoveryId ApiEndpointId (string)

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

The unique ID of an Api discovery endpoint resource

ApiEndpoint ApiEndpoint (string)

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

A compliant URI

]

ApiMetadata object

]

AuthorisationServerCertifications

object[]

Array [

CertificationStartDate CertificationStartDate (string)

Possible values: Value must match regular expression ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$

JSONDatetime of certification start date

CertificationExpirationDate CertificationExpirationDate (string)

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

JSONDatetime of certification expiration date

CertificationId AuthorisationServerCertificationId (string)

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

Unique ID associated with the auth server certification

AuthorisationServerId AuthorisationServerId (string)

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

CertificationStatus CertificationStatusEnum (string)

Possible values: [Awaiting Certification, Certified, Deprecated, Rejected, Warning, Self-Certified]

Default value: Awaiting Certification

The different types of certification status

ProfileVariant ProfileVariant (string)

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

Certification variant

ProfileType ProfileType (string)

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

Certification type

ProfileVersion number

The version number of the certification

CertificationURI uri

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

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

Status StatusEnum (string)

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

]

Flags

object[]

Array [

Id FlagID (string)

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

Unique ID of the flag

CreatedAt date-time

UpdatedAt date-time

]

]

OrgDomainClaims

object[]

Array [

OrganisationAuthorityDomainClaimId string

The unique org authority domain claim ID

AuthorisationDomainName string

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

The authorisation domain name

AuthorityId string

The GUID of the Authority

AuthorityName string

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

The name of the Authority

RegistrationId string

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

The registration ID

Status StatusEnum (string)

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

]

OrgDomainRoleClaims

object[]

Array [

Authorisations

object[]

Array [

Status StatusEnum (string)

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

MemberState string

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

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

]

RoleType string

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

Type of authorisation domain role

Exclusive ExclusiveAuthorisationDomainRole (boolean)

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

Metadata object

Possible values: <= 255 characters

Authorisation domain role metadata

]

SoftwareStatements

object

property name*

object

SoftwareDetails

object

SoftwareStatementCertifications

object[]

Array [

CertificationStartDate CertificationStartDate (string)

Possible values: Value must match regular expression ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$

JSONDatetime of certification start date

CertificationExpirationDate CertificationExpirationDate (string)

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

JSONDatetime of certification expiration date

CertificationId SoftwareStatementCertificationId (string)

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

Unique ID associated with the software statement certification

SoftwareStatementId SoftwareStatementId (string)

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

Unique Software Statement Id

Status StatusEnum (string)

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

ProfileVariant ProfileVariant (string)

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

Certification variant

ProfileType ProfileType (string)

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

Certification type

ProfileVersion number

The version number of the certification

CertificationURI uri

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

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

CertificationStatus CertificationStatusEnum (string)

Possible values: [Awaiting Certification, Certified, Deprecated, Rejected, Warning, Self-Certified]

Default value: Awaiting Certification

The different types of certification status

]

Status string

Possible values: [Active, Suspended, Inactive]

Default value: Active

Is this software statement Active/Suspended/Inactive

ClientId ClientId (string)

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

Software Statement client Id

ClientName ClientName (string)

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

Software Statement client name

Description string

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

Software Statement description

Environment string

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

The additional check for software statement, this field can avoid

FederationEndpoint uri

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

The federation endpoint for the Authorisation Server

OrganisationId OrganisationId (string)

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

Unique ID associated with the organisation

SoftwareStatementId SoftwareStatementId (string)

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

Unique Software Statement Id

Mode SoftwareStatementMode (string)

Possible values: [Live, Test]

Default value: Live

Software Statement mode

RtsClientCreated boolean

Client created flag

OnBehalfOf string

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

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

PolicyUri 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

ClientUri uri

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

The Software Statement client compliant URI

LogoUri uri

Possible values: Value must match regular expression ^(http://|https://).*.(svg|png|jpg|jpeg)$|(data:image/[a-zA-Z0-9;+=-]+,[A-Za-z0-9+/]*={0,2})$

A compliant URI

RedirectUri uri[]

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

PostLogoutRedirectUris uri[]

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

ApiWebhookUri uri[]

Possible values: <= 255 characters, Value must match regular expression ^(https:\/\/[^\s/?#]+(?:\/[^\s\/?#]+)*)$

TermsOfServiceUri uri

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

The Software Statement terms of service compliant URI

NotificationWebhook uri

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

A compliant URI

NotificationWebhookStatus NotificationWebhookStatusEnum (string)

Possible values: [Pending, Confirmed, Deactivated]

Default value: Pending

SoftwareVersion RFCCompliantSoftwareVersion (string)

Possible values: <= 40 characters

Software Statement version as provided by the organisation's software team

Version SoftwareVersion (number)deprecated

Possible values: <= 40 characters

Software Statement version as provided by the organisation's software team

Locked boolean

Flag shows if assertion has been generated on the software statement - will be set to true when assertion is generated

UpdateFailed boolean

Flag shows if software statement is in failed update state

UpdateFailedReason string

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

Error message describing why the update failed

AdditionalSoftwareMetadata AdditionalSoftwareMetadata (string)

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

Extra metadata defined by the org admins to be loaded into the software statement and made avaiable during introspection

OpenidFederationEnabled OpenidFederationEnabled (boolean)

Is this software statement enabled for federation

OpenidFederationEntityManagementType OpenidFederationEntityManagementType (string)

Possible values: [openid_entity_federation_managed, openid_entity_self_managed]

The type of federation management that applies to this software statement

RequireSignedRequestObject RequireSignedRequestObject (boolean)

Default value: true

Require a signed request object. If this is set to false, the client will not be FAPI compliant

IdTokenSignedResponseAlgorithm IdTokenSignedResponseAlgorithm (string)

Possible values: [PS256, RS256]

Default value: PS256

Signing algorithm that a client expects the server to return an id_token with. Must be PS256

TokenEndpointAuthMethod TokenEndpointAuthMethod (string)

Possible values: non-empty and <= 60 characters, [private_key_jwt, tls_client_auth, client_secret_basic]

Default value: private_key_jwt

Token endpoint authentication method

ClientSecret string

Possible values: <= 255 characters

The client secret, only returned when a client is created/updated to have client_secret_basic auth type

CreatedAt date-time

OriginUri uri[]

Possible values: <= 255 characters, Value must match regular expression ^https:\/\/(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]+(?::\d+)?(?:\/[a-zA-Z0-9-._~!$&'()*+,;=:@\/?%]*)?(?:\?[a-zA-Z0-9-._~!$&'()*+,;=:@\/?%]*)?(?:#[a-zA-Z0-9-._~!$&'()*+,;=:@\/?%]*)?$|(^android:apk-key-hash:[a-zA-Z0-9-]+)|(^ios:bundle-id:[a-zA-Z][-a-zA-Z0-9]*\.([a-zA-Z][-a-zA-Z0-9]*\.?)+)$

TlsClientCertificateBoundAccessTokens TlsClientCertificateBoundAccessTokens (boolean)

Default value: true

Are the tokens issued for this client bound to a client tls certificate

RelatedAuthorisationServer uuidnullable

ID of the Authorisation Server that is connected to this Software Statement

Flags

object[]

Array [

Id FlagID (string)

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

Unique ID of the flag

CreatedAt date-time

UpdatedAt date-time

Name FlagName (string)required

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

The name of this flag

Description FlagDescription (string)

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

The description of this flag

Type FlagType (string)required

Possible values: [Organisation, Software_Statement, Authorisation_Server]

The type of this tag

Value FlagValue (string)required

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

The value of this flag

Status StatusEnum (string)required

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

AccessLevel FlagAccessLevel (integer)required

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

]

HomepageUri uri

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

The URI for the website with details about the application and its services

SoftwareAuthorityClaims

object[]

Array [

SoftwareStatementId SoftwareStatementId (string)

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

Unique Software Statement Id

SoftwareAuthorityClaimId SoftwareAuthorityClaimId (string)

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

Unique ID associated with the authority claims for a software statement

Status StatusEnum (string)

Possible values: [Active, Inactive]

Default value: Active

Current status of this resource

AuthorisationDomain string

Possible values: <= 30 characters

Authorisation domain for the authority

Role AuthorisationDomainRoleName (string)

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

The authorisation domain role name

]

SoftwareCertificates

object[]

Array [

OrganisationId OrganisationId (string)

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

Unique ID associated with the organisation

SoftwareStatementIds SoftwareStatementId (string)[]

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

ClientName string

Possible values: <= 40 characters

Status string

Possible values: <= 40 characters

ValidFromDateTime string

Possible values: <= 30 characters

RevokedDateTime string

Possible values: <= 30 characters

ExpiryDateTime string

Possible values: <= 30 characters

e string

Possible values: <= 255 characters

keyType string

Possible values: <= 255 characters

kid string

Possible values: <= 255 characters

kty string

Possible values: <= 255 characters

n string

Possible values: <= 255 characters

use string

Possible values: <= 255 characters

x5c string[]

Possible values: <= 255 characters

x5t string

Possible values: <= 255 characters

x5thashS256 string

Possible values: <= 255 characters

x5u string

Possible values: <= 255 characters

SignedCertPath string

Possible values: <= 255 characters

Used to display location of the signed certificate in PEM format

JwkPath string

Possible values: <= 255 characters

Used to display path to JWKS containing this certificate

OrgJwkPath string

Possible values: <= 255 characters

Used to display path to Org JWKS containing org certificates

]

OrganisationCertificates

object[]

Array [

OrganisationId OrganisationId (string)

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

Unique ID associated with the organisation

SoftwareStatementIds SoftwareStatementId (string)[]

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

ClientName string

Possible values: <= 40 characters

Status string

Possible values: <= 40 characters

ValidFromDateTime string

Possible values: <= 30 characters

RevokedDateTime string

Possible values: <= 30 characters

ExpiryDateTime string

Possible values: <= 30 characters

e string

Possible values: <= 255 characters

keyType string

Possible values: <= 255 characters

kid string

Possible values: <= 255 characters

kty string

Possible values: <= 255 characters

n string

Possible values: <= 255 characters

use string

Possible values: <= 255 characters

x5c string[]

Possible values: <= 255 characters

x5t string

Possible values: <= 255 characters

x5thashS256 string

Possible values: <= 255 characters

x5u string

Possible values: <= 255 characters

SignedCertPath string

Possible values: <= 255 characters

Used to display location of the signed certificate in PEM format

JwkPath string

Possible values: <= 255 characters

Used to display path to JWKS containing this certificate

OrgJwkPath string

Possible values: <= 255 characters

Used to display path to Org JWKS containing org certificates

]

Example (from schema)

{
  "OrganisationDetails": {
    "OrganisationId": "string",
    "Status": "Active",
    "OrganisationName": "string",
    "CreatedOn": "string",
    "LegalEntityName": "string",
    "CountryOfRegistration": "string",
    "CompanyRegister": "string",
    "Size": "string",
    "RegistrationNumber": "string",
    "RegistrationId": "string",
    "RegisteredName": "string",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Postcode": "string",
    "Country": "string",
    "ParentOrganisationReference": "string",
    "RequiresParticipantTermsAndConditionsSigning": true,
    "LogoUri": "string",
    "Flags": [
      {
        "Id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
        "CreatedAt": "2024-07-29T15:51:28.071Z",
        "UpdatedAt": "2024-07-29T15:51:28.071Z",
        "Name": "string",
        "Description": "string",
        "Type": "Organisation",
        "Value": "string",
        "Status": "Active",
        "AccessLevel": 0
      }
    ]
  },
  "Contacts": [
    {
      "ContactId": "string",
      "OrganisationId": "string",
      "ContactType": "Business",
      "FirstName": "string",
      "LastName": "string",
      "Department": "string",
      "EmailAddress": "string",
      "PhoneNumber": "string",
      "AddressLine1": "string",
      "AddressLine2": "string",
      "City": "string",
      "Postcode": "string",
      "Country": "string",
      "AdditionalInformation": "string",
      "PgpPublicKey": "string"
    }
  ],
  "AuthorisationServers": [
    {
      "ApiResources": [
        {
          "ApiDiscoveryEndpoints": [
            {
              "ApiDiscoveryId": "string",
              "ApiEndpoint": "https://raidiam.io/cb"
            }
          ],
          "ApiMetadata": {},
          "ApiResourceId": "string",
          "ApiVersion": "string",
          "FamilyComplete": true,
          "ApiCertificationUri": "string",
          "CertificationStatus": "Awaiting Certification",
          "CertificationStartDate": "string",
          "CertificationExpirationDate": "string",
          "ApiFamilyType": "string",
          "Status": "Active"
        }
      ],
      "AuthorisationServerCertifications": [
        {
          "CertificationStartDate": "string",
          "CertificationExpirationDate": "string",
          "CertificationId": "string",
          "AuthorisationServerId": "string",
          "CertificationStatus": "Awaiting Certification",
          "ProfileVariant": "FAPI Adv. OP w/ MTLS",
          "ProfileType": "Redirect",
          "ProfileVersion": 0,
          "CertificationURI": "string",
          "Status": "Active"
        }
      ],
      "Flags": [
        {
          "Id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
          "CreatedAt": "2024-07-29T15:51:28.071Z",
          "UpdatedAt": "2024-07-29T15:51:28.071Z",
          "Name": "string",
          "Description": "string",
          "Type": "Organisation",
          "Value": "string",
          "Status": "Active",
          "AccessLevel": 0
        }
      ],
      "Status": "Active",
      "AuthorisationServerId": "string",
      "AutoRegistrationNotificationWebhook": "string",
      "AutoRegistrationSupported": false,
      "CreatedAt": "2024-07-29T15:51:28.071Z",
      "CustomerFriendlyDescription": "string",
      "CustomerFriendlyLogoUri": "string",
      "CustomerFriendlyName": "string",
      "DeprecatedDate": "2021-01-30",
      "DeveloperPortalUri": "string",
      "FederationEndpoint": "string",
      "FederationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Issuer": "string",
      "NotificationWebhook": "string",
      "NotificationWebhookAddedDate": "2021-01-30",
      "NotificationWebhookStatus": "Pending",
      "OpenIDDiscoveryDocument": "string",
      "OrganisationId": "string",
      "ParentAuthorisationServerId": "string",
      "PayloadSigningCertLocationUri": "string",
      "RetirementDate": "2023-12-30",
      "SupersededByAuthorisationServerId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
      "SupportsCiba": false,
      "SupportsDCR": false,
      "SupportsRedirect": false,
      "TermsOfServiceUri": "string"
    }
  ],
  "OrgDomainClaims": [
    {
      "OrganisationAuthorityDomainClaimId": "string",
      "AuthorisationDomainName": "string",
      "AuthorityId": "string",
      "AuthorityName": "string",
      "RegistrationId": "string",
      "Status": "Active"
    }
  ],
  "OrgDomainRoleClaims": [
    {
      "Authorisations": [
        {
          "Status": "Active",
          "MemberState": "string"
        }
      ],
      "RoleType": "string",
      "Exclusive": true,
      "Metadata": {},
      "OrganisationId": "string",
      "OrganisationAuthorityClaimId": "string",
      "AuthorityId": "string",
      "Status": "Active",
      "AuthorisationDomain": "string",
      "Role": "PAGTO",
      "RegistrationId": "string",
      "UniqueTechnicalIdentifiers": [
        "string"
      ]
    }
  ],
  "SoftwareStatements": {},
  "OrganisationCertificates": [
    {
      "OrganisationId": "string",
      "SoftwareStatementIds": [
        "string"
      ],
      "ClientName": "string",
      "Status": "string",
      "ValidFromDateTime": "string",
      "RevokedDateTime": "string",
      "ExpiryDateTime": "string",
      "e": "string",
      "keyType": "string",
      "kid": "string",
      "kty": "string",
      "n": "string",
      "use": "string",
      "x5c": [
        "string"
      ],
      "x5t": "string",
      "x5thashS256": "string",
      "x5u": "string",
      "SignedCertPath": "string",
      "JwkPath": "string",
      "OrgJwkPath": "string"
    }
  ]
}

401

Unauthorized

Response Headers

• x-fapi-interaction-id

  string

403

Forbidden

Response Headers

• x-fapi-interaction-id

  string

404

Not found

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

errors string[]

Validation Error messages

Example (from schema)

{
  "errors": [
    "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...