Create Citizen

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

Resource Information

Scopeusers

Deprecated scope name:   create_citizenaccess_citizens

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNo�Indicates the language applied.7.3.3.4
associatedLicenseIds[]longNo�Contains license ID's associated with the citizen user.7.3.3.4
cellPhonestringNo�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.addressLine1stringNo�The first line of the address. 7.3.3.4
contacts.additionalAddresses.addressLine2stringNo�The second line of the address.7.3.3.4
contacts.additionalAddresses.addressLine3stringNo�The third line of the address.7.3.3.4
contacts.additionalAddresses.citystringNo�The name of the city.7.3.3.4
contacts.additionalAddresses.countrycontacts.additionalAddresses.country{}No Get All Address Countries The name of the country.7.3.3.4
contacts.additionalAddresses.country.textstringNo�The localized display text.7.3.3.4
contacts.additionalAddresses.country.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.additionalAddresses.effectiveDatedateTimeNo�The date when you want the condition to become effective.7.3.3.4
contacts.additionalAddresses.entityIDlongNo�The unique ID of the entity or record.7.3.3.4
contacts.additionalAddresses.expirationDatedateTimeNo�The date when the condition expires.7.3.3.4
contacts.additionalAddresses.faxstringNo�The fax number for the contact.7.3.3.4
contacts.additionalAddresses.faxCountryCodestringNo�Fax Number Country Code7.3.3.4
contacts.additionalAddresses.fullAddressstringNo�The full address.7.3.3.4
contacts.additionalAddresses.houseNumberAlphaEndstringNo�The alphabetic ending street number that makes up the address.7.3.3.4
contacts.additionalAddresses.houseNumberAlphaStartstringNo�The alphabetic beginning street number that makes up the address.7.3.3.4
contacts.additionalAddresses.houseNumberEndlongNo�The ending street number that makes up the address.7.3.3.4
contacts.additionalAddresses.houseNumberStartlongNo�The beginning street number that makes up the address.7.3.3.4
contacts.additionalAddresses.idlongNo�The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
contacts.additionalAddresses.levelNumberEndstringNo�The ending level number (floor number) that makes up the address within a complex.7.3.3.4
contacts.additionalAddresses.levelNumberStartstringNo�The beginning level number (floor number) that makes up the address within a complex.7.3.3.4
contacts.additionalAddresses.levelPrefixstringNo�The prefix for the level numbers (floor numbers) that make up the address.7.3.3.4
contacts.additionalAddresses.phonestringNo�The telephone number of the contact.7.3.3.4
contacts.additionalAddresses.phoneCountryCodestringNo�The country code for the associated phone number.7.3.3.4
contacts.additionalAddresses.postalCodestringNo�The postal ZIP code for the address.7.3.3.4
contacts.additionalAddresses.primarystringNo��7.3.3.4
contacts.additionalAddresses.recipientstringNo�The entity on the receiving end of an operation, for example a notification of an event.7.3.3.4
contacts.additionalAddresses.statecontacts.additionalAddresses.state{}No Get All Address States The state corresponding to the address on record.7.3.3.4
contacts.additionalAddresses.state.textstringNo�The localized display text.7.3.3.4
contacts.additionalAddresses.state.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.additionalAddresses.statuscontacts.additionalAddresses.status{}No�The contact address status.7.3.3.4
contacts.additionalAddresses.streetDirectioncontacts.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.textstringNo�The localized display text.7.3.3.4
contacts.additionalAddresses.streetDirection.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.additionalAddresses.streetNamestringNo�The street name for the address.7.3.3.4
contacts.additionalAddresses.streetPrefixstringNo�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.streetSuffixcontacts.additionalAddresses.streetSuffix{}No Get All Address Street Suffixes The type of street such as "Lane" or "Boulevard".7.3.3.4
contacts.additionalAddresses.streetSuffix.textstringNo�The localized display text.7.3.3.4
contacts.additionalAddresses.streetSuffix.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.additionalAddresses.streetSuffixDirectioncontacts.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.textstringNo�The localized display text.7.3.3.4
contacts.additionalAddresses.streetSuffixDirection.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.additionalAddresses.typecontacts.additionalAddresses.type{}No�The address type.7.3.3.4
contacts.additionalAddresses.type.textstringNo�The localized display text.7.3.3.4
contacts.additionalAddresses.type.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.additionalAddresses.unitEndstringNo�The end parameter of a range of unit numbers.7.3.3.4
contacts.additionalAddresses.unitStartstringNo�The starting parameter of a range of unit numbers.7.3.3.4
contacts.additionalAddresses.unitTypecontacts.additionalAddresses.unitType{}No Get All Address Unit Types The unit type designation of the address.7.3.3.4
contacts.additionalAddresses.unitType.textstringNo�The localized display text.7.3.3.4
contacts.additionalAddresses.unitType.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.additionalAddresses.validateFlagstringNo��7.3.3.4
contacts.addresscontacts.address{}No�The citizen user's address.7.3.3.4
contacts.address.addressLine1stringNo�The first line of the address. 7.3.3.4
contacts.address.addressLine2stringNo�The second line of the address.7.3.3.4
contacts.address.addressLine3stringNo�The third line of the address.7.3.3.4
contacts.address.citystringNo�The name of the city.7.3.3.4
contacts.address.countrycontacts.address.country{}No Get All Address Countries The name of the country.7.3.3.4
contacts.address.country.textstringNo�The localized display text.7.3.3.4
contacts.address.country.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.address.statecontacts.address.state{}No Get All Address States The state corresponding to the address on record.7.3.3.4
contacts.address.state.textstringNo�The localized display text.7.3.3.4
contacts.address.state.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.address.zipstringNo�The address zip code.7.3.3.4
contacts.birthCitycontacts.birthCity{}No�The city of birth for an individual.7.3.3.4
contacts.birthCity.textstringNo�The localized display text.7.3.3.4
contacts.birthCity.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.birthDatedateTimeNo�The birth date of an individual.7.3.3.4
contacts.birthRegioncontacts.birthRegion{}No�The country of birth or region of birth for an individual.7.3.3.4
contacts.birthRegion.textstringNo�The localized display text.7.3.3.4
contacts.birthRegion.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.birthStatecontacts.birthState{}No Get All Address States The state of birth for an individual.7.3.3.4
contacts.birthState.textstringNo�The localized display text.7.3.3.4
contacts.birthState.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.businessNamestringNo�A secondary business name for the applicable individual.7.3.3.4
contacts.commentstringNo�Comments or notes about the current context.7.3.3.4
contacts.deceasedDatedateTimeNo�The date of death. This field is active only when the Contact Type selected is Individual.7.3.3.4
contacts.driverLicenseNumberstringNo�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.driverLicenseStatecontacts.driverLicenseState{}No Get All Address States The state that issued the driver's license.7.3.3.4
contacts.driverLicenseState.textstringNo�The localized display text.7.3.3.4
contacts.driverLicenseState.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.emailstringNo�The contact's email address.7.3.3.4
contacts.faxstringNo�The fax number for the contact.7.3.3.4
contacts.faxCountryCodestringNo�Fax Number Country Code7.3.3.4
contacts.federalEmployerIdstringNo�The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.3.4
contacts.firstNamestringNo�The contact's first name. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.fullNamestringNo�The contact's full name. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.gendercontacts.gender{}No�The gender (male or female) of the individual.7.3.3.4
contacts.gender.textstringNo�The localized display text.7.3.3.4
contacts.gender.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.idstringNo�The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
contacts.individualOrOrganizationstringNo�The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.3.4
contacts.lastNamestringNo�The last name (surname). 7.3.3.4
contacts.middleNamestringNo�The middle name. 7.3.3.4
contacts.organizationNamestringNo�The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.3.4
contacts.passportNumberstringNo�The contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.phone1stringNo�The primary telephone number of the contact. 7.3.3.4
contacts.phone1CountryCodestringNo�Phone Number 1 Country Code7.3.3.4
contacts.phone2stringNo�The secondary telephone number of the contact.7.3.3.4
contacts.phone2CountryCodestringNo�Phone Number 2 Country Code7.3.3.4
contacts.phone3stringNo�The tertiary telephone number for the contact.7.3.3.4
contacts.phone3CountryCodestringNo�Phone Number 3 Country Code7.3.3.4
contacts.postOfficeBoxstringNo�The post office box number.7.3.3.4
contacts.preferredChannelcontacts.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.textstringNo�The localized display text.7.3.3.4
contacts.preferredChannel.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.racecontacts.race{}No Get All Contact Races The contact's race/ethnicity.7.3.3.4
contacts.race.textstringNo�The localized display text.7.3.3.4
contacts.race.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.relationcontacts.relation{}No�The contact's relationship to the application or service request.7.3.3.4
contacts.relation.textstringNo�The localized display text.7.3.3.4
contacts.relation.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.salutationcontacts.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.textstringNo�The localized display text.7.3.3.4
contacts.salutation.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.serviceProviderCodestringNo�The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.4
contacts.socialSecurityNumberstringNo�The individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.stateIdNumberstringNo�The contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.statuscontacts.status{}No�The contact status.7.3.3.4
contacts.status.textstringNo�The localized display text.7.3.3.4
contacts.status.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.suffixstringNo�The contact name suffix.7.3.3.4
contacts.titlestringNo�The individual's business title. 7.3.3.4
contacts.tradeNamestringNo�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.typecontacts.type{}No Get All Contact Types The type of people to contact. 7.3.3.4
contacts.type.textstringNo�The localized display text.7.3.3.4
contacts.type.valuestringNo�The value for the specified parameter.7.3.3.4
emailstringNo�The citizen user's email address.7.3.3.4
passwordstringNo�The citizen user's password.7.3.3.4
questions[]questions{}No�Contains the security questions for password reset.7.3.3.4
questions.answerstringNo�The answer to the security question for password reset.7.3.3.4
questions.orderstringNo�The order of the security question.7.3.3.4
questions.questionstringNo�The security question for password reset. 7.3.3.4
receiveSMSstringNoY | NIndicates whether or not the user prefers to receive SMS messages.7.3.3.4
rolestringNoCONTRACT_INSPECTOR | CITIZEN | AUTH_AGENT_CLERK | AUTH_AGENT | SELF_CERTIFIED_INSPECTORThe citizen user's role: CONTRACT_INSPECTOR, CITIZEN, AUTH_AGENT_CLERK, AUTH_AGENT, SELF_CERTIFIED_INSPECTOR.7.3.3.4
servProvCodestringNo�The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.4
userNamestringNo�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

FieldTypeDescriptionAutomation Version
resultresult{}�7.3.3.4
result.codestringA code identifying an associated item7.3.3.4
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.3.4
result.messagestringA text message related to the operation.7.3.3.4
statusintegerThe record status.7.3.3.4

Example

Sample Response Body

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