Get Citizen Accounts

Gets the status of the citizen accounts associated to the specified user.

Resource Information


Deprecated scope name:   get_citizens_accounts

App TypeAll
Authorization TypeAccess token
URI /v4/citizenaccess/citizens/{id}/accounts?id={id}&lang={lang}
Automation Version(s)

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
idstringYesThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.
langStringNoIndicates the language applied.


Sample Request Head


Response Information

FieldTypeDescriptionAutomation Version
result[]result{}Contains account activation information.
result.activestringIndicates whether or not the account is active. If the account is not activated, the user cannot login Accela Citizen Access.
result.agentIdlongThe ID of the associated agent of the logged-in user.
result.serviceProviderCodestringThe agency name.
result.statusstringThe citizen userid status.
result.userIdlongThe citizen userid.
statusintegerThe record status.


Sample Response Body

  "result": [
      "servProvCode": "BPTDEV",
      "userId": 14,
      "status": "Enable",
      "active": "Yes"
  "status": 200