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

COGNITO_JWTCUSTOMER_USER_API_KEY

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 /products/web/12345/portal/backend/api/v1/organisation-profiles/me HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "createdAt": "2025-12-20T21:35:25.977Z",
  "updatedAt": "2025-12-20T21:35:25.977Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "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

COGNITO_JWTCUSTOMER_USER_API_KEY

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 /products/web/12345/portal/backend/api/v1/organisation-profiles HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 32

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

{
  "id": "text",
  "createdAt": "2025-12-20T21:35:25.977Z",
  "updatedAt": "2025-12-20T21:35:25.977Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "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

COGNITO_JWTISSUER_API_JWTCUSTOMER_USER_API_KEY

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 /products/web/12345/portal/backend/api/v1/organisation-profiles/{id} HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "createdAt": "2025-12-20T21:35:25.977Z",
  "updatedAt": "2025-12-20T21:35:25.977Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "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

COGNITO_JWTCUSTOMER_USER_API_KEY

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

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

HTTPcURLJavaScriptPython

DELETE /products/web/12345/portal/backend/api/v1/organisation-profiles/{id} HTTP/1.1
Host: identity.products.teranode.group
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

COGNITO_JWTCUSTOMER_USER_API_KEY

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 /products/web/12345/portal/backend/api/v1/organisation-profiles/{id} HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "createdAt": "2025-12-20T21:35:25.977Z",
  "updatedAt": "2025-12-20T21:35:25.977Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "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

COGNITO_JWTCUSTOMER_USER_API_KEY

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 /products/web/12345/portal/backend/api/v1/organisation-profiles/{id}/image HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "createdAt": "2025-12-20T21:35:25.977Z",
  "updatedAt": "2025-12-20T21:35:25.977Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "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

COGNITO_JWTCUSTOMER_USER_API_KEY

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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 /products/web/12345/portal/backend/api/v1/organisation-profiles/{id}/image HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}

{
  "id": "text",
  "createdAt": "2025-12-20T21:35:25.977Z",
  "updatedAt": "2025-12-20T21:35:25.977Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}