Create Citizen

Adds a citizen user to be associated with the currently logged-in user. The userName to be added is required.

Resource Information

Scope	users Deprecated scope name: create_citizenaccess_citizens
App Type	All
Authorization Type	Access token
URI	/v4/citizenaccess/citizens?lang={lang}
HTTP Method	POST
Automation Version(s)	7.3.3.4

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
lang	String	No	ï¿½	Indicates the language applied.	7.3.3.4
associatedLicenseIds[]	long	No	ï¿½	Contains license ID's associated with the citizen user.	7.3.3.4
cellPhone	string	No	ï¿½	The citizen user's cell phone number.	7.3.3.4
contacts[]	contacts{}	No	ï¿½	The contact information for the citizen user.	7.3.3.4
contacts.additionalAddresses[]	contacts.additionalAddresses{}	No	ï¿½	Additional address information.	7.3.3.4
contacts.additionalAddresses.addressLine1	string	No	ï¿½	The first line of the address.	7.3.3.4
contacts.additionalAddresses.addressLine2	string	No	ï¿½	The second line of the address.	7.3.3.4
contacts.additionalAddresses.addressLine3	string	No	ï¿½	The third line of the address.	7.3.3.4
contacts.additionalAddresses.city	string	No	ï¿½	The name of the city.	7.3.3.4
contacts.additionalAddresses.country	contacts.additionalAddresses.country{}	No	Get All Address Countries	The name of the country.	7.3.3.4
contacts.additionalAddresses.country.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.additionalAddresses.country.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.additionalAddresses.effectiveDate	dateTime	No	ï¿½	The date when you want the condition to become effective.	7.3.3.4
contacts.additionalAddresses.entityID	long	No	ï¿½	The unique ID of the entity or record.	7.3.3.4
contacts.additionalAddresses.expirationDate	dateTime	No	ï¿½	The date when the condition expires.	7.3.3.4
contacts.additionalAddresses.fax	string	No	ï¿½	The fax number for the contact.	7.3.3.4
contacts.additionalAddresses.faxCountryCode	string	No	ï¿½	Fax Number Country Code	7.3.3.4
contacts.additionalAddresses.fullAddress	string	No	ï¿½	The full address.	7.3.3.4
contacts.additionalAddresses.houseNumberAlphaEnd	string	No	ï¿½	The alphabetic ending street number that makes up the address.	7.3.3.4
contacts.additionalAddresses.houseNumberAlphaStart	string	No	ï¿½	The alphabetic beginning street number that makes up the address.	7.3.3.4
contacts.additionalAddresses.houseNumberEnd	long	No	ï¿½	The ending street number that makes up the address.	7.3.3.4
contacts.additionalAddresses.houseNumberStart	long	No	ï¿½	The beginning street number that makes up the address.	7.3.3.4
contacts.additionalAddresses.id	long	No	ï¿½	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.3.4
contacts.additionalAddresses.levelNumberEnd	string	No	ï¿½	The ending level number (floor number) that makes up the address within a complex.	7.3.3.4
contacts.additionalAddresses.levelNumberStart	string	No	ï¿½	The beginning level number (floor number) that makes up the address within a complex.	7.3.3.4
contacts.additionalAddresses.levelPrefix	string	No	ï¿½	The prefix for the level numbers (floor numbers) that make up the address.	7.3.3.4
contacts.additionalAddresses.phone	string	No	ï¿½	The telephone number of the contact.	7.3.3.4
contacts.additionalAddresses.phoneCountryCode	string	No	ï¿½	The country code for the associated phone number.	7.3.3.4
contacts.additionalAddresses.postalCode	string	No	ï¿½	The postal ZIP code for the address.	7.3.3.4
contacts.additionalAddresses.primary	string	No	ï¿½	ï¿½	7.3.3.4
contacts.additionalAddresses.recipient	string	No	ï¿½	The entity on the receiving end of an operation, for example a notification of an event.	7.3.3.4
contacts.additionalAddresses.state	contacts.additionalAddresses.state{}	No	Get All Address States	The state corresponding to the address on record.	7.3.3.4
contacts.additionalAddresses.state.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.additionalAddresses.state.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.additionalAddresses.status	contacts.additionalAddresses.status{}	No	ï¿½	The contact address status.	7.3.3.4
contacts.additionalAddresses.streetDirection	contacts.additionalAddresses.streetDirection{}	No	Get All Address Street Directions	The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.	7.3.3.4
contacts.additionalAddresses.streetDirection.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.additionalAddresses.streetDirection.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.additionalAddresses.streetName	string	No	ï¿½	The street name for the address.	7.3.3.4
contacts.additionalAddresses.streetPrefix	string	No	ï¿½	Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.	7.3.3.4
contacts.additionalAddresses.streetSuffix	contacts.additionalAddresses.streetSuffix{}	No	Get All Address Street Suffixes	The type of street such as "Lane" or "Boulevard".	7.3.3.4
contacts.additionalAddresses.streetSuffix.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.additionalAddresses.streetSuffix.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.additionalAddresses.streetSuffixDirection	contacts.additionalAddresses.streetSuffixDirection{}	No	Get All Address Street Directions	The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.	7.3.3.4
contacts.additionalAddresses.streetSuffixDirection.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.additionalAddresses.streetSuffixDirection.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.additionalAddresses.type	contacts.additionalAddresses.type{}	No	ï¿½	The address type.	7.3.3.4
contacts.additionalAddresses.type.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.additionalAddresses.type.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.additionalAddresses.unitEnd	string	No	ï¿½	The end parameter of a range of unit numbers.	7.3.3.4
contacts.additionalAddresses.unitStart	string	No	ï¿½	The starting parameter of a range of unit numbers.	7.3.3.4
contacts.additionalAddresses.unitType	contacts.additionalAddresses.unitType{}	No	Get All Address Unit Types	The unit type designation of the address.	7.3.3.4
contacts.additionalAddresses.unitType.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.additionalAddresses.unitType.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.additionalAddresses.validateFlag	string	No	ï¿½	ï¿½	7.3.3.4
contacts.address	contacts.address{}	No	ï¿½	The citizen user's address.	7.3.3.4
contacts.address.addressLine1	string	No	ï¿½	The first line of the address.	7.3.3.4
contacts.address.addressLine2	string	No	ï¿½	The second line of the address.	7.3.3.4
contacts.address.addressLine3	string	No	ï¿½	The third line of the address.	7.3.3.4
contacts.address.city	string	No	ï¿½	The name of the city.	7.3.3.4
contacts.address.country	contacts.address.country{}	No	Get All Address Countries	The name of the country.	7.3.3.4
contacts.address.country.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.address.country.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.address.state	contacts.address.state{}	No	Get All Address States	The state corresponding to the address on record.	7.3.3.4
contacts.address.state.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.address.state.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.address.zip	string	No	ï¿½	The address zip code.	7.3.3.4
contacts.birthCity	contacts.birthCity{}	No	ï¿½	The city of birth for an individual.	7.3.3.4
contacts.birthCity.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.birthCity.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.birthDate	dateTime	No	ï¿½	The birth date of an individual.	7.3.3.4
contacts.birthRegion	contacts.birthRegion{}	No	ï¿½	The country of birth or region of birth for an individual.	7.3.3.4
contacts.birthRegion.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.birthRegion.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.birthState	contacts.birthState{}	No	Get All Address States	The state of birth for an individual.	7.3.3.4
contacts.birthState.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.birthState.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.businessName	string	No	ï¿½	A secondary business name for the applicable individual.	7.3.3.4
contacts.comment	string	No	ï¿½	Comments or notes about the current context.	7.3.3.4
contacts.deceasedDate	dateTime	No	ï¿½	The date of death. This field is active only when the Contact Type selected is Individual.	7.3.3.4
contacts.driverLicenseNumber	string	No	ï¿½	The driver's license number of the contact. This field is active only when the Contact Type selected is Individual.	7.3.3.4
contacts.driverLicenseState	contacts.driverLicenseState{}	No	Get All Address States	The state that issued the driver's license.	7.3.3.4
contacts.driverLicenseState.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.driverLicenseState.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.email	string	No	ï¿½	The contact's email address.	7.3.3.4
contacts.fax	string	No	ï¿½	The fax number for the contact.	7.3.3.4
contacts.faxCountryCode	string	No	ï¿½	Fax Number Country Code	7.3.3.4
contacts.federalEmployerId	string	No	ï¿½	The Federal Employer Identification Number. It is used to identify a business for tax purposes.	7.3.3.4
contacts.firstName	string	No	ï¿½	The contact's first name. This field is only active when the Contact Type selected is Individual.	7.3.3.4
contacts.fullName	string	No	ï¿½	The contact's full name. This field is only active when the Contact Type selected is Individual.	7.3.3.4
contacts.gender	contacts.gender{}	No	ï¿½	The gender (male or female) of the individual.	7.3.3.4
contacts.gender.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.gender.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.id	string	No	ï¿½	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.3.4
contacts.individualOrOrganization	string	No	ï¿½	The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.	7.3.3.4
contacts.lastName	string	No	ï¿½	The last name (surname).	7.3.3.4
contacts.middleName	string	No	ï¿½	The middle name.	7.3.3.4
contacts.organizationName	string	No	ï¿½	The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.	7.3.3.4
contacts.passportNumber	string	No	ï¿½	The contact's passport number. This field is only active when the Contact Type selected is Individual.	7.3.3.4
contacts.phone1	string	No	ï¿½	The primary telephone number of the contact.	7.3.3.4
contacts.phone1CountryCode	string	No	ï¿½	Phone Number 1 Country Code	7.3.3.4
contacts.phone2	string	No	ï¿½	The secondary telephone number of the contact.	7.3.3.4
contacts.phone2CountryCode	string	No	ï¿½	Phone Number 2 Country Code	7.3.3.4
contacts.phone3	string	No	ï¿½	The tertiary telephone number for the contact.	7.3.3.4
contacts.phone3CountryCode	string	No	ï¿½	Phone Number 3 Country Code	7.3.3.4
contacts.postOfficeBox	string	No	ï¿½	The post office box number.	7.3.3.4
contacts.preferredChannel	contacts.preferredChannel{}	No	Get All Contact Preferred Channels	The method by which the contact prefers to be notified, by phone for example.	7.3.3.4
contacts.preferredChannel.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.preferredChannel.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.race	contacts.race{}	No	Get All Contact Races	The contact's race/ethnicity.	7.3.3.4
contacts.race.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.race.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.relation	contacts.relation{}	No	ï¿½	The contact's relationship to the application or service request.	7.3.3.4
contacts.relation.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.relation.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.salutation	contacts.salutation{}	No	Get All Contact Salutations	The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual.	7.3.3.4
contacts.salutation.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.salutation.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.serviceProviderCode	string	No	ï¿½	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.3.4
contacts.socialSecurityNumber	string	No	ï¿½	The individual's social security number. This field is only active when the Contact Type selected is Individual.	7.3.3.4
contacts.stateIdNumber	string	No	ï¿½	The contact's state ID number. This field is only active when the Contact Type selected is Individual.	7.3.3.4
contacts.status	contacts.status{}	No	ï¿½	The contact status.	7.3.3.4
contacts.status.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.status.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
contacts.suffix	string	No	ï¿½	The contact name suffix.	7.3.3.4
contacts.title	string	No	ï¿½	The individual's business title.	7.3.3.4
contacts.tradeName	string	No	ï¿½	The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.	7.3.3.4
contacts.type	contacts.type{}	No	Get All Contact Types	The type of people to contact.	7.3.3.4
contacts.type.text	string	No	ï¿½	The localized display text.	7.3.3.4
contacts.type.value	string	No	ï¿½	The value for the specified parameter.	7.3.3.4
email	string	No	ï¿½	The citizen user's email address.	7.3.3.4
password	string	No	ï¿½	The citizen user's password.	7.3.3.4
questions[]	questions{}	No	ï¿½	Contains the security questions for password reset.	7.3.3.4
questions.answer	string	No	ï¿½	The answer to the security question for password reset.	7.3.3.4
questions.order	string	No	ï¿½	The order of the security question.	7.3.3.4
questions.question	string	No	ï¿½	The security question for password reset.	7.3.3.4
receiveSMS	string	No	Y \| N	Indicates whether or not the user prefers to receive SMS messages.	7.3.3.4
role	string	No	CONTRACT_INSPECTOR \| CITIZEN \| AUTH_AGENT_CLERK \| AUTH_AGENT \| SELF_CERTIFIED_INSPECTOR	The citizen user's role: CONTRACT_INSPECTOR, CITIZEN, AUTH_AGENT_CLERK, AUTH_AGENT, SELF_CERTIFIED_INSPECTOR.	7.3.3.4
servProvCode	string	No	ï¿½	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.3.4
userName	string	No	ï¿½	The user's unique username.	7.3.3.4

Example

Sample Request Head

POST https://apis.accela.com/v4/citizenaccess/citizens

Sample Request Body

    "email": "rs9987@accela.com",
    "questions": [
        {
            "answer": "Dublin",
            "order": "1",
            "question": "What city were you born in?"
        }
    ],
    "contacts": [
        {
            "phone2": "9251231234",
            "phone1": "2345567890",
            "phone3": "2334567890",
            "tradeName": "trade name",
            "federalEmployerId": "987654",
            "individualOrOrganization": "organization",
            "organizationName": "Traget",
            "serviceProviderCode": "BPTDEV",
            "email": "rs998@accela.com",
            "businessName": "business name 2",
            "type": {
                "value": "Organization",
                "text": "Organization"
            },
            "preferredChannel": {
                "value": "1",
                "text": "Email"
            },
            "relation": {
                "value": "License Holder",
                "text": "License Holder"
            },
            "status": {
                "value": "A",
                "text": "Active"
            },
            "address": {
                "country": {
                    "value": "US",
                    "text": "United States"
                }
            }
        }
    ],
    "cellPhone": "9254133218",
    "password": "cat12345",
    "userName": "targetClerk4",
    "receiveSMS": "y",
    "servProvCode": "BPTDEV",
    "role": "AUTH_AGENT_CLERK",
    "associatedLicenseIds": [
        ""
    ]

Response Information

Field	Type	Description	Automation Version
result	result{}	ï¿½	7.3.3.4
result.code	string	A code identifying an associated item	7.3.3.4
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.3.4
result.isSuccess	boolean	Indicates whether or not the operation on the item is successful.	7.3.3.4
result.message	string	A text message related to the operation.	7.3.3.4
status	integer	The record status.	7.3.3.4

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "id": 110411
  }
}