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
langStringNoIndicates the language applied.7.3.3.4
associatedLicenseIds[]longNoContains license ID's associated with the citizen user.7.3.3.4
cellPhonestringNoThe citizen user's cell phone number.7.3.3.4
contacts[]contacts{}NoThe contact information for the citizen user.7.3.3.4
contacts.additionalAddresses[]contacts.additionalAddresses{}NoAdditional address information.7.3.3.4
contacts.additionalAddresses.addressLine1stringNoThe first line of the address. 7.3.3.4
contacts.additionalAddresses.addressLine2stringNoThe second line of the address.7.3.3.4
contacts.additionalAddresses.addressLine3stringNoThe third line of the address.7.3.3.4
contacts.additionalAddresses.citystringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.additionalAddresses.country.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.additionalAddresses.effectiveDatedateTimeNoThe date when you want the condition to become effective.7.3.3.4
contacts.additionalAddresses.entityIDlongNoThe unique ID of the entity or record.7.3.3.4
contacts.additionalAddresses.expirationDatedateTimeNoThe date when the condition expires.7.3.3.4
contacts.additionalAddresses.faxstringNoThe fax number for the contact.7.3.3.4
contacts.additionalAddresses.faxCountryCodestringNoFax Number Country Code7.3.3.4
contacts.additionalAddresses.fullAddressstringNoThe full address.7.3.3.4
contacts.additionalAddresses.houseNumberAlphaEndstringNoThe alphabetic ending street number that makes up the address.7.3.3.4
contacts.additionalAddresses.houseNumberAlphaStartstringNoThe alphabetic beginning street number that makes up the address.7.3.3.4
contacts.additionalAddresses.houseNumberEndlongNoThe ending street number that makes up the address.7.3.3.4
contacts.additionalAddresses.houseNumberStartlongNoThe beginning street number that makes up the address.7.3.3.4
contacts.additionalAddresses.idlongNoThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
contacts.additionalAddresses.levelNumberEndstringNoThe ending level number (floor number) that makes up the address within a complex.7.3.3.4
contacts.additionalAddresses.levelNumberStartstringNoThe beginning level number (floor number) that makes up the address within a complex.7.3.3.4
contacts.additionalAddresses.levelPrefixstringNoThe prefix for the level numbers (floor numbers) that make up the address.7.3.3.4
contacts.additionalAddresses.phonestringNoThe telephone number of the contact.7.3.3.4
contacts.additionalAddresses.phoneCountryCodestringNoThe country code for the associated phone number.7.3.3.4
contacts.additionalAddresses.postalCodestringNoThe postal ZIP code for the address.7.3.3.4
contacts.additionalAddresses.primarystringNo7.3.3.4
contacts.additionalAddresses.recipientstringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.additionalAddresses.state.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.additionalAddresses.statuscontacts.additionalAddresses.status{}NoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.additionalAddresses.streetDirection.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.additionalAddresses.streetNamestringNoThe street name for the address.7.3.3.4
contacts.additionalAddresses.streetPrefixstringNoAny 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.textstringNoThe localized display text.7.3.3.4
contacts.additionalAddresses.streetSuffix.valuestringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.additionalAddresses.streetSuffixDirection.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.additionalAddresses.typecontacts.additionalAddresses.type{}NoThe address type.7.3.3.4
contacts.additionalAddresses.type.textstringNoThe localized display text.7.3.3.4
contacts.additionalAddresses.type.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.additionalAddresses.unitEndstringNoThe end parameter of a range of unit numbers.7.3.3.4
contacts.additionalAddresses.unitStartstringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.additionalAddresses.unitType.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.additionalAddresses.validateFlagstringNo7.3.3.4
contacts.addresscontacts.address{}NoThe citizen user's address.7.3.3.4
contacts.address.addressLine1stringNoThe first line of the address. 7.3.3.4
contacts.address.addressLine2stringNoThe second line of the address.7.3.3.4
contacts.address.addressLine3stringNoThe third line of the address.7.3.3.4
contacts.address.citystringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.address.country.valuestringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.address.state.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.address.zipstringNoThe address zip code.7.3.3.4
contacts.birthCitycontacts.birthCity{}NoThe city of birth for an individual.7.3.3.4
contacts.birthCity.textstringNoThe localized display text.7.3.3.4
contacts.birthCity.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.birthDatedateTimeNoThe birth date of an individual.7.3.3.4
contacts.birthRegioncontacts.birthRegion{}NoThe country of birth or region of birth for an individual.7.3.3.4
contacts.birthRegion.textstringNoThe localized display text.7.3.3.4
contacts.birthRegion.valuestringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.birthState.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.businessNamestringNoA secondary business name for the applicable individual.7.3.3.4
contacts.commentstringNoComments or notes about the current context.7.3.3.4
contacts.deceasedDatedateTimeNoThe date of death. This field is active only when the Contact Type selected is Individual.7.3.3.4
contacts.driverLicenseNumberstringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.driverLicenseState.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.emailstringNoThe contact's email address.7.3.3.4
contacts.faxstringNoThe fax number for the contact.7.3.3.4
contacts.faxCountryCodestringNoFax Number Country Code7.3.3.4
contacts.federalEmployerIdstringNoThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.3.4
contacts.firstNamestringNoThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.fullNamestringNoThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.gendercontacts.gender{}NoThe gender (male or female) of the individual.7.3.3.4
contacts.gender.textstringNoThe localized display text.7.3.3.4
contacts.gender.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.idstringNoThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
contacts.individualOrOrganizationstringNoThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.3.4
contacts.lastNamestringNoThe last name (surname). 7.3.3.4
contacts.middleNamestringNoThe middle name. 7.3.3.4
contacts.organizationNamestringNoThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.3.4
contacts.passportNumberstringNoThe contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.phone1stringNoThe primary telephone number of the contact. 7.3.3.4
contacts.phone1CountryCodestringNoPhone Number 1 Country Code7.3.3.4
contacts.phone2stringNoThe secondary telephone number of the contact.7.3.3.4
contacts.phone2CountryCodestringNoPhone Number 2 Country Code7.3.3.4
contacts.phone3stringNoThe tertiary telephone number for the contact.7.3.3.4
contacts.phone3CountryCodestringNoPhone Number 3 Country Code7.3.3.4
contacts.postOfficeBoxstringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.preferredChannel.valuestringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.race.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.relationcontacts.relation{}NoThe contact's relationship to the application or service request.7.3.3.4
contacts.relation.textstringNoThe localized display text.7.3.3.4
contacts.relation.valuestringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.salutation.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.serviceProviderCodestringNoThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.4
contacts.socialSecurityNumberstringNoThe individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.stateIdNumberstringNoThe contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.3.4
contacts.statuscontacts.status{}NoThe contact status.7.3.3.4
contacts.status.textstringNoThe localized display text.7.3.3.4
contacts.status.valuestringNoThe value for the specified parameter.7.3.3.4
contacts.suffixstringNoThe contact name suffix.7.3.3.4
contacts.titlestringNoThe individual's business title. 7.3.3.4
contacts.tradeNamestringNoThe 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.textstringNoThe localized display text.7.3.3.4
contacts.type.valuestringNoThe value for the specified parameter.7.3.3.4
emailstringNoThe citizen user's email address.7.3.3.4
passwordstringNoThe citizen user's password.7.3.3.4
questions[]questions{}NoContains the security questions for password reset.7.3.3.4
questions.answerstringNoThe answer to the security question for password reset.7.3.3.4
questions.orderstringNoThe order of the security question.7.3.3.4
questions.questionstringNoThe 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
servProvCodestringNoThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.4
userNamestringNoThe 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
  }
}