Person Admin APIs

Identity Management APIs

List registered persons in the system.

get

Retrieves a list of persons registered in the identity management system. This endpoint is intended for administrative use, allowing authorized users to view and manage user profiles. The results can be paginated using the limit and start parameters.

💻 Service Credentials is required to access this service.

🔒 Permission: persons.list is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Query parameters

limitinteger · int32OptionalDefault: 10

startinteger · int32OptionalDefault: 0

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/identities/admin/persons

HTTPcURLJavaScriptPython

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

{
  "count": 1,
  "limit": 1,
  "skip": 1,
  "docs": [
    {
      "id": "text",
      "namespace": "text",
      "deleted": true,
      "verification": {
        "status": "started",
        "reason": "text",
        "timestamp": "2025-12-16T22:14:25.766Z"
      },
      "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:14:25.766Z"
        }
      ],
      "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:14:25.766Z",
          "expiration_date": "2025-12-16T22:14:25.766Z",
          "update_date": "2025-12-16T22:14:25.766Z"
        }
      ],
      "documents": [
        {
          "type": "VISA",
          "country_code": "text",
          "link": "https://example.com",
          "date_effective": "2025-12-16T22:14:25.766Z",
          "date_expires": "2025-12-16T22:14:25.766Z",
          "date_created": "2025-12-16T22:14:25.766Z",
          "vendor_reference_data": "text",
          "vendor": "text"
        }
      ],
      "credentials": {
        "oidc": {
          "type": "text",
          "identifiers": [
            "text"
          ]
        },
        "password": {
          "type": "text",
          "config": {
            "password": "text"
          }
        }
      },
      "creation_date": "2025-12-16T22:14:25.766Z",
      "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"
      }
    }
  ]
}

Create a new person record as an admin.

post

This endpoint allows an admin to create a new person record in the identity management system. The created record represents a digital profile that can be customized by the user. This action is crucial for managing user identities and ensuring accurate representation in the system.

💻 Service Credentials is required to access this service.

🔒 Permission: persons.create is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Body

application/json

idstringOptional

namespacestringOptional

deletedbooleanOptional

creation_datestring · date-timeOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/identities/admin/persons

HTTPcURLJavaScriptPython

POST /identities/admin/persons 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:14:25.766Z"
  },
  "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:14:25.766Z"
    }
  ],
  "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:14:25.766Z",
      "expiration_date": "2025-12-16T22:14:25.766Z",
      "update_date": "2025-12-16T22:14:25.766Z"
    }
  ],
  "documents": [
    {
      "type": "VISA",
      "country_code": "text",
      "link": "https://example.com",
      "date_effective": "2025-12-16T22:14:25.766Z",
      "date_expires": "2025-12-16T22:14:25.766Z",
      "date_created": "2025-12-16T22:14:25.766Z",
      "vendor_reference_data": "text",
      "vendor": "text"
    }
  ],
  "credentials": {
    "oidc": {
      "type": "text",
      "identifiers": [
        "text"
      ]
    },
    "password": {
      "type": "text",
      "config": {
        "password": "text"
      }
    }
  },
  "creation_date": "2025-12-16T22:14:25.766Z",
  "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:14:25.766Z"
  },
  "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:14:25.766Z"
    }
  ],
  "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:14:25.766Z",
      "expiration_date": "2025-12-16T22:14:25.766Z",
      "update_date": "2025-12-16T22:14:25.766Z"
    }
  ],
  "documents": [
    {
      "type": "VISA",
      "country_code": "text",
      "link": "https://example.com",
      "date_effective": "2025-12-16T22:14:25.766Z",
      "date_expires": "2025-12-16T22:14:25.766Z",
      "date_created": "2025-12-16T22:14:25.766Z",
      "vendor_reference_data": "text",
      "vendor": "text"
    }
  ],
  "credentials": {
    "oidc": {
      "type": "text",
      "identifiers": [
        "text"
      ]
    },
    "password": {
      "type": "text",
      "config": {
        "password": "text"
      }
    }
  },
  "creation_date": "2025-12-16T22:14:25.766Z",
  "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"
  }
}

Retrieve a specific person's record as an admin.

get

This endpoint allows an admin to access the detailed profile of a user. The information retrieved is intended for identity management purposes and is visible only to authorized personnel. Ensure proper authentication is in place to protect sensitive user data.

💻 Service Credentials is required to access this service.

🔒 Permission: persons.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

personIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/identities/admin/persons/{personId}

HTTPcURLJavaScriptPython

GET /identities/admin/persons/{personId} 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:14:25.766Z"
  },
  "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:14:25.766Z"
    }
  ],
  "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:14:25.766Z",
      "expiration_date": "2025-12-16T22:14:25.766Z",
      "update_date": "2025-12-16T22:14:25.766Z"
    }
  ],
  "documents": [
    {
      "type": "VISA",
      "country_code": "text",
      "link": "https://example.com",
      "date_effective": "2025-12-16T22:14:25.766Z",
      "date_expires": "2025-12-16T22:14:25.766Z",
      "date_created": "2025-12-16T22:14:25.766Z",
      "vendor_reference_data": "text",
      "vendor": "text"
    }
  ],
  "credentials": {
    "oidc": {
      "type": "text",
      "identifiers": [
        "text"
      ]
    },
    "password": {
      "type": "text",
      "config": {
        "password": "text"
      }
    }
  },
  "creation_date": "2025-12-16T22:14:25.766Z",
  "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"
  }
}

Admin update of a person's profile.

put

Updates the profile information of a specified person. This operation is intended for administrative users to modify user records, ensuring that the digital presence of individuals is accurate and up-to-date. It provides the necessary access to manage identities effectively.

💻 Service Credentials is required to access this service.

🔒 Permission: persons.update is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

personIdstringRequired

Body

application/json

idstringOptional

namespacestringOptional

deletedbooleanOptional

creation_datestring · date-timeOptional

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/identities/admin/persons/{personId}

HTTPcURLJavaScriptPython

PUT /identities/admin/persons/{personId} 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:14:25.766Z"
  },
  "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:14:25.766Z"
    }
  ],
  "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:14:25.766Z",
      "expiration_date": "2025-12-16T22:14:25.766Z",
      "update_date": "2025-12-16T22:14:25.766Z"
    }
  ],
  "documents": [
    {
      "type": "VISA",
      "country_code": "text",
      "link": "https://example.com",
      "date_effective": "2025-12-16T22:14:25.766Z",
      "date_expires": "2025-12-16T22:14:25.766Z",
      "date_created": "2025-12-16T22:14:25.766Z",
      "vendor_reference_data": "text",
      "vendor": "text"
    }
  ],
  "credentials": {
    "oidc": {
      "type": "text",
      "identifiers": [
        "text"
      ]
    },
    "password": {
      "type": "text",
      "config": {
        "password": "text"
      }
    }
  },
  "creation_date": "2025-12-16T22:14:25.766Z",
  "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:14:25.766Z"
  },
  "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:14:25.766Z"
    }
  ],
  "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:14:25.766Z",
      "expiration_date": "2025-12-16T22:14:25.766Z",
      "update_date": "2025-12-16T22:14:25.766Z"
    }
  ],
  "documents": [
    {
      "type": "VISA",
      "country_code": "text",
      "link": "https://example.com",
      "date_effective": "2025-12-16T22:14:25.766Z",
      "date_expires": "2025-12-16T22:14:25.766Z",
      "date_created": "2025-12-16T22:14:25.766Z",
      "vendor_reference_data": "text",
      "vendor": "text"
    }
  ],
  "credentials": {
    "oidc": {
      "type": "text",
      "identifiers": [
        "text"
      ]
    },
    "password": {
      "type": "text",
      "config": {
        "password": "text"
      }
    }
  },
  "creation_date": "2025-12-16T22:14:25.766Z",
  "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"
  }
}

Admin delete a specified person profile

delete

This endpoint allows an administrator to delete a person's profile from the identity management system. The action removes the user's digital presence, ensuring that their information is no longer accessible. This operation is crucial for maintaining data privacy and compliance with user requests.

💻 Service Credentials is required to access this service.

🔒 Permission: persons.delete is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

personIdstringRequired

Responses

200

OK

No content

401

Unauthorized

*/*

delete

/identities/admin/persons/{personId}

HTTPcURLJavaScriptPython

DELETE /identities/admin/persons/{personId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Retrieve demographic information for a specific person.

get

This endpoint allows administrators to access the demographic details of a person identified by their unique ID. It is intended for internal use to manage and update user information effectively. Ensure proper authorization is in place to protect sensitive data.

💻 Service Credentials is required to access this service.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Path parameters

personIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/identities/admin/persons/{personId}/demographics

HTTPcURLJavaScriptPython

GET /identities/admin/persons/{personId}/demographics HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "age": "_0_to_14",
  "income": "none",
  "gender": "male",
  "household": true,
  "relationship_status": "single",
  "parental_status": "parent"
}