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

bearerCUSTOMER_USER_API_KEY

Responses

200Success

application/json

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

get

/api/v1/organisation-profiles/me

HTTPcURLJavaScriptPython

GET /api/v1/organisation-profiles/me HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "createdAt": "2025-10-30T23:19:00.112Z",
  "updatedAt": "2025-10-30T23:19:00.112Z",
  "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

bearerCUSTOMER_USER_API_KEY

Body

multipart/form-data

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

/api/v1/organisation-profiles

HTTPcURLJavaScriptPython

POST /api/v1/organisation-profiles HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 32

{
  "name": "text",
  "image": "binary"
}

{
  "id": "text",
  "createdAt": "2025-10-30T23:19:00.112Z",
  "updatedAt": "2025-10-30T23:19:00.112Z",
  "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, Identity_Issuer_Api

Authorizations

bearerCUSTOMER_USER_API_KEY

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

/api/v1/organisation-profiles/{id}

HTTPcURLJavaScriptPython

GET /api/v1/organisation-profiles/{id} HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "createdAt": "2025-10-30T23:19:00.112Z",
  "updatedAt": "2025-10-30T23:19:00.112Z",
  "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

bearerCUSTOMER_USER_API_KEY

Path parameters

idstringRequired

Responses

204Success

No content

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

404

Organisation profile not found.

delete

/api/v1/organisation-profiles/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/organisation-profiles/{id} HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
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

bearerCUSTOMER_USER_API_KEY

Path parameters

idstringRequired

Body

application/json

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

/api/v1/organisation-profiles/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/organisation-profiles/{id} HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "createdAt": "2025-10-30T23:19:00.112Z",
  "updatedAt": "2025-10-30T23:19:00.112Z",
  "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

bearerCUSTOMER_USER_API_KEY

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

/api/v1/organisation-profiles/{id}/image

HTTPcURLJavaScriptPython

DELETE /api/v1/organisation-profiles/{id}/image HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "createdAt": "2025-10-30T23:19:00.112Z",
  "updatedAt": "2025-10-30T23:19:00.112Z",
  "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

bearerCUSTOMER_USER_API_KEY

Path parameters

idstringRequired

Body

multipart/form-data

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

/api/v1/organisation-profiles/{id}/image

HTTPcURLJavaScriptPython

PATCH /api/v1/organisation-profiles/{id}/image HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}

{
  "id": "text",
  "createdAt": "2025-10-30T23:19:00.112Z",
  "updatedAt": "2025-10-30T23:19:00.112Z",
  "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"
  }
}