Get Citizen Accounts

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

Resource Information

Scopeusers

Deprecated scope name:   get_citizens_accounts

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
langStringNo Indicates the language applied.7.3.3.4

Example

Sample Request Head

GET https://apis.accela.com/v4/citizenaccess/citizens/14/accounts

Response Information

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

Example

Sample Response Body

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