Get My Citizen Profile

Gets the profile for the currently logged in citizen user.

Resource Information

Scopeusers

Deprecated scope name:   get_citizenaccess_user_profile

App TypeCitizen
Authorization TypeAccess token
URI /v4/citizenaccess/profile?fields={fields}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.3.4

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.3.4
langStringNo Indicates the language applied.7.3.3.4

Example

Sample Request Head

GET https://apis.accela.com/v4/citizenaccess/profile

Notes

This example uses an access token for a CivicID which is linked to an ACA user.

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.3.4
result.emailstringThe citizen user's email address.7.3.3.4
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.loginNamestringThe citizen user's login name.7.3.3.4
result.mobilePhonestringThe citizen user's 10-digit cell phone number.7.3.3.4
result.receiveSMSstringIndicates whether or not the user prefers to receive SMS messages.7.3.3.4
result.registerDatedateTimeThe citizen user's registration date.7.3.3.4
result.rolestringThe citizen user's role: CONTRACT_INSPECTOR, CITIZEN, AUTH_AGENT_CLERK, AUTH_AGENT, SELF_CERTIFIED_INSPECTOR.7.3.3.4
statusintegerThe record status.7.3.3.4

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "email": "jtest@test.com",
    "id": 110189,
    "loginName": "jacktest",
    "registerDate": "2015-02-09 16:23:58",
    "role": "CITIZEN",
    "receiveSMS": "N"
  }
}