Skip to main content

Get the participant open-data and write to S3

GET 
/participants

Triggers an open data export generating the participants endpoint

Request​

Header Parameters

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

Responses​

Export the open-data for all the organisations

Response Headers

  • x-fapi-interaction-id

    string

Schema

  • Array [

    • OrganisationId OrganisationId (string)

    Possible values: non-empty and <= 40 characters

    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

    Name of the organisation.

    CreatedOn string

    Possible values: <= 30 characters

    JSONDatetime of organisation creation.

    LegalEntityName string

    Possible values: <= 255 characters

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

    CountryOfRegistration string

    Possible values: <= 255 characters

    Country of registration for the org

    CompanyRegister string

    Possible values: <= 255 characters

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

    Tags string[]

    Possible values: <= 255 characters

    Tags to describe or classify an organisation

    Flags object

    JSON key-value pairs containing the flags the resource owns grouped by flag type

    Size string

    Possible values: <= 255 characters

    Size of an organisation

    RegistrationNumber string

    Possible values: <= 255 characters

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

    RegistrationId string

    Possible values: <= 40 characters

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

    RegisteredName string

    Possible values: <= 255 characters

    AddressLine1 string

    Possible values: <= 255 characters

    Address line 1

    AddressLine2 string

    Possible values: <= 255 characters

    Address line 2

    City string

    Possible values: <= 255 characters

    City

    Postcode string

    Possible values: <= 40 characters

    Postcode

    Country string

    Possible values: <= 255 characters

    Country

    ParentOrganisationReference string

    Possible values: <= 65535 characters

    Parent Organisation Reference

    AuthorisationServers

    object[]

  • Array [

    • ApiResources

    object[]

  • Array [

    • ApiDiscoveryEndpoints

    object[]

  • Array [

    • ApiDiscoveryId ApiEndpointId (string)

    Possible values: <= 40 characters

    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)

    JSONDatetime of certification expiration date

    CertificationId AuthorisationServerCertificationId (string)

    Possible values: non-empty and <= 40 characters

    Unique ID associated with the auth server certification

    AuthorisationServerId AuthorisationServerId (string)

    Possible values: <= 40 characters

    Status string

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

    Default value: Awaiting Certification

    Is this certification current or expired

    ProfileVariant ProfileVariant (string)

    Certification variant

    ProfileType ProfileType (string)

    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

  • ]

    • Flags object

    JSON key-value pairs containing the flags the resource owns grouped by flag type

  • ]

    • OrgDomainClaims

    object[]

  • Array [

    • OrganisationAuthorityDomainClaimId string

    The unique org authority domain claim ID

    AuthorisationDomainName string

    The authorisation domain name

    AuthorityId string

    The GUID of the Authority

    AuthorityName string

    The name of the Authority

    RegistrationId string

    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

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

  • ]

    • RoleType string

    Possible values: <= 255 characters

    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

  • ]

  • ]

Loading...