Skip to main content

Get the top 10 results based on a partial/full match of identifier

GET 
/search

Get the top 10 results based on a partial/full match of identifier

Request​

Query Parameters

    identifier Identifierrequired

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

    The string to search for

    resourceTypes GlobalSearchResourceType[]

    Possible values: [organisation, softwareStatement, authorisationServer, certificate]

    Comma-separated list of resource types to filter by

    status StatusEnum

    Possible values: [Active, Inactive]

    Default value: Active

    Filter responses by status

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​

Global Search response

Response Headers

  • x-fapi-interaction-id

    string

Schema

    results

    object[]

  • Array [

    • resourceType GlobalSearchResourceType (string)required

    Possible values: [organisation, softwareStatement, authorisationServer, certificate]

    name stringrequired
    legalEntityName stringnullable
    organisationId stringnullable
    softwareStatementId SoftwareStatementId (string)

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

    Unique Software Statement Id

    identifier stringrequired
    status GlobalSearchStatusEnum (string)required

    Possible values: [Active, Inactive, Suspended, Withdrawn, Pending]

    Default value: Active

    Status of the resource

  • ]

Loading...