# Get details for one client

**GET /clients/{ClientId}**




## Servers
- Raidiam Directory Sandbox Environment: https://matls-api.sandbox.raidiam.io (Raidiam Directory Sandbox Environment)


## Authentication methods
- O auth


## Parameters
### 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
- **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
- **ClientId** (string)
  Oauth clientId



## Responses
### 200
All registered clients
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **application_type** (string)
  OIDC application type response
- **authorization_details_types** (array[string])
  Defines whether or not a client is allowed to send RAR requests with authorization_details of specific types
- **claims** (array[string])
  The claim names aggregated from domain role metadata for this client
- **claims_in_verified_claims** (array[string])
  The verified claim names aggregated from domain role metadata for this client
- **client_description** (string)
  Client description
- **client_id** (string)
  Software Statement client Id
- **client_name** (string)
  Software Statement client name
- **client_uri** (string(uri))
  The Software Statement client compliant URI
- **grant_types** (array[string])

- **homepage_uri** (string(uri))
  The URI for the website with details about the application and its services
- **jwks_uri** (string(uri))
  A compliant URI string referencing the client's JSON Web Key (JWK) Set
- **last_updated** (string(date-time))
  JSONDatetime of last updated timestamp
- **logo_uri** (string(uri))
  A compliant URI
- **openid_federation_enabled** (boolean)
  Is this software statement enabled for federation
- **openid_federation_entity_management_type** (string)
  The type of federation management that applies to this software statement
- **org_id** (string)
  Unique ID associated with the organisation
- **organisation_company_register** (string)
  Legal company register for the country, i.e. Companies House
- **organisation_country** (string)
  Country
- **organisation_id** (string)
  Unique ID associated with the organisation
- **organisation_registration_number** (string)
  Company registration number from company register i.e. Companies House registration number
- **policy_uri** (string(uri))
  A compliant URI string that points to a human-readable privacy policy document
- **post_logout_redirect_uris** (array[string(uri)])
  The Software Statement redirect compliant URI
- **redirect_uris** (array[string(uri)])
  The Software Statement redirect compliant URI
- **response_types** (array[string])
  List of response types
- **roles** (array[string])
  The software authority roles that apply to this client
- **scope** (string)
  String containing a space-separated list of scope values
- **sector_identifier_uri** (string(uri))
  A compliant URI string referencing the client's sector identifier
- **software_api_webhook_uri** (array[string(uri)])
  A compliant URI
- **software_flags** (array[object])

- **software_id** (string)
  Unique Software Statement Id
- **software_version** (number)
  Software Statement version as provided by the organisation's software team
- **status** (string)
  Is this software statement Active/Suspended/Inactive
- **subject_type** (string)

- **token_endpoint_auth_method** (string)
  Token endpoint authentication method
- **tos_uri** (string(uri))
  The Software Statement terms of service compliant URI
- **use_mtls_endpoint_aliases** (boolean)
  Is the client required to use endpoints defined in the Authorisation Server Discovery Document, or if non MTLS endpoints can be used

### 400
Bad Request
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **errors** (array[string])
  Validation Error messages

### 401
Unauthorized
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 403
Forbidden
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 404
Not found
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **errors** (array[string])
  Validation Error messages

### 406
Not Acceptable
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 429
Too many requests, maximum capacity reached. Requests are now throttled.
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 500
Internal Server Error
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 502
Bad Gateway
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 504
Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.


[Powered by Bump.sh](https://bump.sh)