User Profiles

Get the profile of the request user.

get

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

Authorizations

x-api-keybearer

Responses

200Success

application/json

401

Invalid authentication credentials.

403

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

get

HTTPcURLJavaScriptPython

GET /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/user-profiles/me HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "createdAt": "2025-08-30T01:45:03.850Z",
  "updatedAt": "2025-08-30T01:45:03.850Z",
  "userCognitoSub": "text",
  "isFirstVisit": true,
  "email": "text",
  "name": "text",
  "profileImage": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Update the profile of the request user.

patch

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

Authorizations

x-api-keybearer

Body

isFirstVisitbooleanOptional

Responses

200Success

application/json

401

Invalid authentication credentials.

403

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

patch

HTTPcURLJavaScriptPython

PATCH /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/user-profiles/me HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "isFirstVisit": true
}

{
  "createdAt": "2025-08-30T01:45:03.850Z",
  "updatedAt": "2025-08-30T01:45:03.850Z",
  "userCognitoSub": "text",
  "isFirstVisit": true,
  "email": "text",
  "name": "text",
  "profileImage": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Delete the profile image of the request user.

delete

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

Authorizations

x-api-keybearer

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

User profile not found.

delete

HTTPcURLJavaScriptPython

DELETE /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/user-profiles/me/image HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "createdAt": "2025-08-30T01:45:03.850Z",
  "updatedAt": "2025-08-30T01:45:03.850Z",
  "userCognitoSub": "text",
  "isFirstVisit": true,
  "email": "text",
  "name": "text",
  "profileImage": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Upload a profile image for the request user.

patch

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

Authorizations

x-api-keybearer

Body

imagestring · binaryRequired

Responses

201Success

application/json

400

Invalid request body.

401

Invalid authentication credentials.

403

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

404

User profile not found.

413

Image exceeds the allowed size.

415

Unsupported media type.

patch

HTTPcURLJavaScriptPython

PATCH /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/user-profiles/me/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"
}

{
  "createdAt": "2025-08-30T01:45:03.850Z",
  "updatedAt": "2025-08-30T01:45:03.850Z",
  "userCognitoSub": "text",
  "isFirstVisit": true,
  "email": "text",
  "name": "text",
  "profileImage": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}