Amend the given organisations details

PUT 
/organisations/:OrganisationId

Updates an 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.

application/json

Body

required

Update an organisation

Status string

Possible values: [Active, Pending, Withdrawn]

Default value: Pending

Status of the directory registration of an organisation

OrganisationName stringrequired

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

LegalEntityName stringrequired

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

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

CountryOfRegistration stringrequired

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

Country of registration for the org

CompanyRegister stringrequired

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

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

Flags FlagID (string)[]

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

Size string

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

Size of the organisation

RegistrationNumber stringrequired

Possible values: non-empty and <= 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 ^[^<>]*$

Registered legal name

AddressLine1 stringrequired

Possible values: >= 5 characters and <= 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 stringrequired

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

City

Postcode stringrequired

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

Postcode

Country stringrequired

Possible values: >= 2 characters and <= 255 characters

Country

ParentOrganisationReference string

Possible values: <= 65535 characters

Parent Organisation Reference

RequiresParticipantTermsAndConditionsSigning boolean

Default value: true

Participant Terms and Conditions Signing Required

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

Responses

200

Full details of the organisation including warnings on a create or update operation

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

OperationWarnings OperationWarning (string)[]

Possible values: [IMAGE_UPLOAD_FAILURE_PLACEHOLDER_USED, IMAGE_VALIDATION_FAILURE_BAD_DATA_ENCODING_PLACEHOLDER_USED, IMAGE_VALIDATION_FAILURE_UNSUPPORTED_IMAGE_FORMAT_PLACEHOLDER_USED, IMAGE_VALIDATION_CONTENT_FAILURE_PLACEHOLDER_USED, IMAGE_VALIDATION_DIMENSIONS_FAILURE_PLACEHOLDER_USED, IMAGE_VALIDATION_MAX_SIZE_FAILURE_PLACEHOLDER_USED, IMAGE_VALIDATION_FAILURE_SVG_VALIDATION_PLACEHOLDER_USED, IMAGE_VALIDATION_CONTENT_WARNING_SUPERUSER_OVERRIDE, IMAGE_VALIDATION_DIMENSIONS_WARNING_SUPERUSER_OVERRIDE]

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

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

]

Example (from schema)

{
  "OperationWarnings": [
    "IMAGE_UPLOAD_FAILURE_PLACEHOLDER_USED"
  ],
  "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
    }
  ]
}

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

404

Not found

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

errors string[]

Validation Error messages

Example (from schema)

{
  "errors": [
    "string"
  ]
}

406

Not Acceptable

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...