Back to All

Organisation Profiles

List organisation profiles for the request user's environment.

get

Claim-based access control: Issuer_Admin, Issuer_Auditor, Issuer_User, Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations
Responses
200Success
application/json
get
GET /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/organisation-profiles/me HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "createdAt": "2025-06-19T15:03:45.894Z",
  "updatedAt": "2025-06-19T15:03:45.894Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Create an organisation profile.

post

If its a first organisation profile, it is set as default.Accepts the next image formats: image/jpeg, image/png, image/gif, image/webp. Max size is: 2097152 bytes.

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations
Body
namestring · min: 1 · max: 64Required
imagestring · binaryOptional
Responses
201Success
application/json
post
POST /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/organisation-profiles HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 32

{
  "name": "text",
  "image": "binary"
}
{
  "id": "text",
  "createdAt": "2025-06-19T15:03:45.894Z",
  "updatedAt": "2025-06-19T15:03:45.894Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Retrieve an organisation profile by id.

get

Claim-based access control: Issuer_Admin, Issuer_Auditor, Issuer_User, Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/organisation-profiles/{id} HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "createdAt": "2025-06-19T15:03:45.894Z",
  "updatedAt": "2025-06-19T15:03:45.894Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Delete an organisation profile by id.

delete

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations
Path parameters
idstringRequired
Responses
204Success
delete
DELETE /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/organisation-profiles/{id} HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Updates an organisation profile that belongs to the user's environment with provided data.

patch

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations
Path parameters
idstringRequired
Body
namestring · min: 1 · max: 64Optional
Responses
200Success
application/json
patch
PATCH /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/organisation-profiles/{id} HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "id": "text",
  "createdAt": "2025-06-19T15:03:45.894Z",
  "updatedAt": "2025-06-19T15:03:45.894Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Delete an image on the user's environment organisation profile.

delete

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
delete
DELETE /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/organisation-profiles/{id}/image HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "createdAt": "2025-06-19T15:03:45.894Z",
  "updatedAt": "2025-06-19T15:03:45.894Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Update an image on the user's environment organisation profile.

patch

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations
Path parameters
idstringRequired
Body
imagestring · binaryRequired
Responses
200Success
application/json
patch
PATCH /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/organisation-profiles/{id}/image HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}
{
  "id": "text",
  "createdAt": "2025-06-19T15:03:45.894Z",
  "updatedAt": "2025-06-19T15:03:45.894Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}
PreviousMailNextUser Profiles