Person APIs

Identity Management APIs

Retrieve your personal profile information.

get

This endpoint allows users to access their personal profile information. It provides details that are visible to others and customizable for online presence. The information is intended for personal use and management of one's digital identity.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/identities/me/person

HTTPcURLJavaScriptPython

GET /identities/me/person HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "namespace": "text",
  "deleted": true,
  "verification": {
    "status": "started",
    "reason": "text",
    "timestamp": "2025-12-16T22:08:02.699Z"
  },
  "name": [
    {
      "given_name": "text",
      "family_name": "text",
      "middle_name": "text",
      "source": "user",
      "locale": "text"
    }
  ],
  "citizenship": [
    {
      "citizenship_country_code": "text",
      "residency_country_code": "text",
      "residency_type": "PERMANENT_VISA",
      "residency_expiration": "2025-12-16T22:08:02.699Z"
    }
  ],
  "contact": {
    "phones": [
      {
        "phone": "text",
        "country_code": "text",
        "phone_type": "MOBILE"
      }
    ],
    "addresses": {
      "address_line_1": "text",
      "address_line_2": "text",
      "postal_code": "text",
      "city_ward": "text",
      "floor": "text",
      "usage": "residence",
      "building_name": "text",
      "state_prefecture": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "country_code": "US"
    },
    "email": "text"
  },
  "ids": [
    {
      "external_id": "text",
      "source": "text",
      "creation_date": "2025-12-16T22:08:02.699Z",
      "expiration_date": "2025-12-16T22:08:02.699Z",
      "update_date": "2025-12-16T22:08:02.699Z"
    }
  ],
  "documents": [
    {
      "type": "VISA",
      "country_code": "text",
      "link": "https://example.com",
      "date_effective": "2025-12-16T22:08:02.699Z",
      "date_expires": "2025-12-16T22:08:02.699Z",
      "date_created": "2025-12-16T22:08:02.699Z",
      "vendor_reference_data": "text",
      "vendor": "text"
    }
  ],
  "credentials": {
    "oidc": {
      "type": "text",
      "identifiers": [
        "text"
      ]
    },
    "password": {
      "type": "text",
      "config": {
        "password": "text"
      }
    }
  },
  "creation_date": "2025-12-16T22:08:02.699Z",
  "status": {
    "supervised_status": {
      "avatar": "deny",
      "third_party_consent": "deny_all"
    },
    "relationship_status": "single",
    "parental_status": "parent"
  },
  "traits": {
    "name": {
      "given_name": "text",
      "family_name": "text",
      "middle_name": "text"
    },
    "birthdate": "2025-12-16",
    "email": "text",
    "username": "text",
    "gender": "male",
    "citizenship": "text",
    "locale": "text"
  },
  "metadata_public": {
    "picture": "text"
  }
}

Update your personal information

put

This endpoint allows users to update their personal profile information. The changes will be reflected in their digital presence, which is customizable and visible to others. Ensure that the provided data is accurate to maintain a trustworthy online identity.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Body

application/json

idstringOptional

namespacestringOptional

deletedbooleanOptional

creation_datestring · date-timeOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/identities/me/person

HTTPcURLJavaScriptPython

PUT /identities/me/person HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1725

{
  "id": "text",
  "namespace": "text",
  "deleted": true,
  "verification": {
    "status": "started",
    "reason": "text",
    "timestamp": "2025-12-16T22:08:02.699Z"
  },
  "name": [
    {
      "given_name": "text",
      "family_name": "text",
      "middle_name": "text",
      "source": "user",
      "locale": "text"
    }
  ],
  "citizenship": [
    {
      "citizenship_country_code": "text",
      "residency_country_code": "text",
      "residency_type": "PERMANENT_VISA",
      "residency_expiration": "2025-12-16T22:08:02.699Z"
    }
  ],
  "contact": {
    "phones": [
      {
        "phone": "text",
        "country_code": "text",
        "phone_type": "MOBILE"
      }
    ],
    "addresses": {
      "address_line_1": "text",
      "address_line_2": "text",
      "postal_code": "text",
      "city_ward": "text",
      "floor": "text",
      "usage": "residence",
      "building_name": "text",
      "state_prefecture": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "country_code": "US"
    },
    "email": "text"
  },
  "ids": [
    {
      "external_id": "text",
      "source": "text",
      "creation_date": "2025-12-16T22:08:02.699Z",
      "expiration_date": "2025-12-16T22:08:02.699Z",
      "update_date": "2025-12-16T22:08:02.699Z"
    }
  ],
  "documents": [
    {
      "type": "VISA",
      "country_code": "text",
      "link": "https://example.com",
      "date_effective": "2025-12-16T22:08:02.699Z",
      "date_expires": "2025-12-16T22:08:02.699Z",
      "date_created": "2025-12-16T22:08:02.699Z",
      "vendor_reference_data": "text",
      "vendor": "text"
    }
  ],
  "credentials": {
    "oidc": {
      "type": "text",
      "identifiers": [
        "text"
      ]
    },
    "password": {
      "type": "text",
      "config": {
        "password": "text"
      }
    }
  },
  "creation_date": "2025-12-16T22:08:02.699Z",
  "status": {
    "supervised_status": {
      "avatar": "deny",
      "third_party_consent": "deny_all"
    },
    "relationship_status": "single",
    "parental_status": "parent"
  },
  "traits": {
    "name": {
      "given_name": "text",
      "family_name": "text",
      "middle_name": "text"
    },
    "birthdate": "2025-12-16",
    "email": "text",
    "username": "text",
    "gender": "male",
    "citizenship": "text",
    "locale": "text"
  },
  "metadata_public": {
    "picture": "text"
  }
}

{
  "id": "text",
  "namespace": "text",
  "deleted": true,
  "verification": {
    "status": "started",
    "reason": "text",
    "timestamp": "2025-12-16T22:08:02.699Z"
  },
  "name": [
    {
      "given_name": "text",
      "family_name": "text",
      "middle_name": "text",
      "source": "user",
      "locale": "text"
    }
  ],
  "citizenship": [
    {
      "citizenship_country_code": "text",
      "residency_country_code": "text",
      "residency_type": "PERMANENT_VISA",
      "residency_expiration": "2025-12-16T22:08:02.699Z"
    }
  ],
  "contact": {
    "phones": [
      {
        "phone": "text",
        "country_code": "text",
        "phone_type": "MOBILE"
      }
    ],
    "addresses": {
      "address_line_1": "text",
      "address_line_2": "text",
      "postal_code": "text",
      "city_ward": "text",
      "floor": "text",
      "usage": "residence",
      "building_name": "text",
      "state_prefecture": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "country_code": "US"
    },
    "email": "text"
  },
  "ids": [
    {
      "external_id": "text",
      "source": "text",
      "creation_date": "2025-12-16T22:08:02.699Z",
      "expiration_date": "2025-12-16T22:08:02.699Z",
      "update_date": "2025-12-16T22:08:02.699Z"
    }
  ],
  "documents": [
    {
      "type": "VISA",
      "country_code": "text",
      "link": "https://example.com",
      "date_effective": "2025-12-16T22:08:02.699Z",
      "date_expires": "2025-12-16T22:08:02.699Z",
      "date_created": "2025-12-16T22:08:02.699Z",
      "vendor_reference_data": "text",
      "vendor": "text"
    }
  ],
  "credentials": {
    "oidc": {
      "type": "text",
      "identifiers": [
        "text"
      ]
    },
    "password": {
      "type": "text",
      "config": {
        "password": "text"
      }
    }
  },
  "creation_date": "2025-12-16T22:08:02.699Z",
  "status": {
    "supervised_status": {
      "avatar": "deny",
      "third_party_consent": "deny_all"
    },
    "relationship_status": "single",
    "parental_status": "parent"
  },
  "traits": {
    "name": {
      "given_name": "text",
      "family_name": "text",
      "middle_name": "text"
    },
    "birthdate": "2025-12-16",
    "email": "text",
    "username": "text",
    "gender": "male",
    "citizenship": "text",
    "locale": "text"
  },
  "metadata_public": {
    "picture": "text"
  }
}

Delete your personal profile

delete

This endpoint allows users to delete their personal profile. This action is irreversible and will remove all associated data from the system. Ensure that you understand the implications of this action before proceeding.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

401

Unauthorized

*/*

delete

/identities/me/person

HTTPcURLJavaScriptPython

DELETE /identities/me/person HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content