Get My Citizen Profile

Gets the profile for the currently logged in citizen user.

Resource Information

Scope	users Deprecated scope name: get_citizenaccess_user_profile
App Type	Citizen
Authorization Type	Access token
URI	/v4/citizenaccess/profile?fields={fields}&lang={lang}
HTTP Method	GET
Automation Version(s)	7.3.3.4

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
fields	string	No	�	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
lang	String	No	�	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

Field	Type	Description	Automation Version
result	result{}	�	7.3.3.4
result.email	string	The citizen user's email address.	7.3.3.4
result.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.3.4
result.loginName	string	The citizen user's login name.	7.3.3.4
result.mobilePhone	string	The citizen user's 10-digit cell phone number.	7.3.3.4
result.receiveSMS	string	Indicates whether or not the user prefers to receive SMS messages.	7.3.3.4
result.registerDate	dateTime	The citizen user's registration date.	7.3.3.4
result.role	string	The citizen user's role: CONTRACT_INSPECTOR, CITIZEN, AUTH_AGENT_CLERK, AUTH_AGENT, SELF_CERTIFIED_INSPECTOR.	7.3.3.4
status	integer	The 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"
  }
}