Organisation Profiles
Claim-based access control: Issuer_Admin
, Issuer_Auditor
, Issuer_User
, Verifier_Admin
, Verifier_Auditor
, Verifier_User
Authorizations
Responses
200Success
application/json
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
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-07-07T14:52:38.366Z",
"updatedAt": "2025-07-07T14:52:38.366Z",
"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"
}
}
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
400
Invalid request body.
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
409
Maximum number of organisation profiles reached. Current limit: 1
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-07-07T14:52:38.366Z",
"updatedAt": "2025-07-07T14:52:38.366Z",
"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"
}
}
Claim-based access control: Issuer_Admin
, Issuer_Auditor
, Issuer_User
, Verifier_Admin
, Verifier_Auditor
, Verifier_User
Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
404
Organisation profile not found.
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-07-07T14:52:38.366Z",
"updatedAt": "2025-07-07T14:52:38.366Z",
"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"
}
}
Claim-based access control: Issuer_Admin
, Verifier_Admin
Authorizations
Path parameters
idstringRequired
Responses
204Success
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
404
Organisation profile not found.
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
Claim-based access control: Issuer_Admin
, Verifier_Admin
Authorizations
Path parameters
idstringRequired
Body
namestring · min: 1 · max: 64Optional
Responses
200Success
application/json
400
Invalid request body.
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
404
Organisation profile not found.
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-07-07T14:52:38.366Z",
"updatedAt": "2025-07-07T14:52:38.366Z",
"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"
}
}
Claim-based access control: Issuer_Admin
, Verifier_Admin
Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
400
Invalid request parameters.
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
404
Organisation profile not found.
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-07-07T14:52:38.366Z",
"updatedAt": "2025-07-07T14:52:38.366Z",
"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"
}
}
Claim-based access control: Issuer_Admin
, Verifier_Admin
Authorizations
Path parameters
idstringRequired
Body
imagestring · binaryRequired
Responses
200Success
application/json
400
Invalid request body.
401
Invalid authentication credentials.
403
User does not have a required claim to perform this operation.
404
Organisation profile not found.
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-07-07T14:52:38.366Z",
"updatedAt": "2025-07-07T14:52:38.366Z",
"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"
}
}