Register Citizen

Registers a new citizen user. The agency name is required in the HTTP header x-accela-agency. The userName to be registered is required. Note: 7.3.3.4 version supports only 1 contact in the request contacts[]. Multiple contacts will be supported in a future release.

Resource Information

Scopeusers

Deprecated scope name:   register_citizenaccess_user

App TypeAll
Authorization TypeNo authorization required
URI /v4/citizenaccess/register?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.directioncontacts.additionalAddresses.direction{}No Get All Address Street Directions The street direction of the primary address associated with the application.7.3.3.4
contacts.additionalAddresses.direction.textstringNo�The localized display text.7.3.3.4
contacts.additionalAddresses.direction.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.additionalAddresses.effectiveDatedateTimeNo�The date when the address takes effect.7.3.3.4
contacts.additionalAddresses.expirationDatedateTimeNo�The date when the address 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.houseAlphaEndstringNo�The ending street number that makes up the address.7.3.3.4
contacts.additionalAddresses.houseAlphaStartstringNo�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.isPrimarystringNoY | NIndicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.3.4
contacts.additionalAddresses.levelEndstringNo�The ending 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.levelStartstringNo�The beginning level number (floor number) that makes up the address within a complex.7.3.3.4
contacts.additionalAddresses.phonestringNo�The telephone number of the user. 7.3.3.4
contacts.additionalAddresses.phoneCountryCodestringNo�The country code for the assoicated phone number.7.3.3.4
contacts.additionalAddresses.postalCodestringNo�The postal ZIP code for the address.7.3.3.4
contacts.additionalAddresses.recipientstringNo�The contact person for the contact address.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{}NoA | IThe address status indicating whether the address is active or inactive.7.3.3.4
contacts.additionalAddresses.status.textstringNo�The localized display text.7.3.3.4
contacts.additionalAddresses.status.valuestringNo�The value for the specified parameter.7.3.3.4
contacts.additionalAddresses.streetAddressstringNo�The street address. 7.3.3.4
contacts.additionalAddresses.streetEndlongNo�The end of a range of street numbers.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.streetStartlongNo�The start of a range of street numbers.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 Get All Address Unit Types 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.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.postalCodestringNo�The postal ZIP code for the address.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.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
idlongNo��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/register

Sample Request Body

{
  "userName": "cathywest",
  "role": "AUTH_AGENT_CLERK",
  "receiveSMS": "Y",
  "servProvCode": "BPTDEV",
  "email": "cwest@test.com",
  "password": "testok",
  "questions": [
    {
      "question": "What is your first pet's name?",
      "answer": "Zoe",
      "order": 1
    }
  ],
  "contacts": [
    {
      "phone1": "9251231234",
      "phone2": "2345567890",
      "phone3": "2334567890",
      "federalEmployerId": "123213123",
      "individualOrOrganization": "organization",
      "organizationName": "Test Drive Inc",
      "businessName": "Test Drive Inc",
      "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": "9254133215",
  "associatedLicenseIds": [
    ""
  ]
}

Notes

This example uses the HTTP headers x-accela-agency=BPTDEV, x-accela-appid=<sample-citizen-app-id>, x-accela-environment=PROD.

Response Information

FieldTypeDescriptionAutomation Version
resultresult{}�7.3.3.4
result.associatedLicenseIds[]longContains license ID's associated with the citizen user.7.3.3.4
result.cellPhonestringThe citizen user's cell phone number.7.3.3.4
result.contacts[]result.contacts{}The contact information for the citizen user.7.3.3.5
result.contacts.additionalAddresses[]result.contacts.additionalAddresses{}�7.3.3.5
result.contacts.additionalAddresses.addressLine1stringThe first line of the address. 7.3.3.5
result.contacts.additionalAddresses.addressLine2stringThe second line of the address.7.3.3.5
result.contacts.additionalAddresses.addressLine3stringThe third line of the address.7.3.3.5
result.contacts.additionalAddresses.citystringThe name of the city.7.3.3.5
result.contacts.additionalAddresses.countryresult.contacts.additionalAddresses.country{}The name of the country.7.3.3.5
result.contacts.additionalAddresses.country.textstringThe localized display text.7.3.3.5
result.contacts.additionalAddresses.country.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.additionalAddresses.directionresult.contacts.additionalAddresses.direction{}The street direction of the primary address associated with the application.7.3.3.5
result.contacts.additionalAddresses.direction.textstringThe localized display text.7.3.3.5
result.contacts.additionalAddresses.direction.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.additionalAddresses.effectiveDatedateTimeThe date when the address takes effect.7.3.3.5
result.contacts.additionalAddresses.expirationDatedateTimeThe date when the address expires.7.3.3.5
result.contacts.additionalAddresses.faxstringThe fax number for the contact.7.3.3.5
result.contacts.additionalAddresses.faxCountryCodestringFax Number Country Code7.3.3.5
result.contacts.additionalAddresses.houseAlphaEndstringThe ending street number that makes up the address.7.3.3.5
result.contacts.additionalAddresses.houseAlphaStartstringThe beginning street number that makes up the address.7.3.3.5
result.contacts.additionalAddresses.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.5
result.contacts.additionalAddresses.isPrimarystringIndicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.3.5
result.contacts.additionalAddresses.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.3.5
result.contacts.additionalAddresses.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.3.5
result.contacts.additionalAddresses.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.3.5
result.contacts.additionalAddresses.phonestringThe telephone number of the contact.7.3.3.5
result.contacts.additionalAddresses.phoneCountryCodestringThe country code for the assoicated phone number.7.3.3.5
result.contacts.additionalAddresses.postalCodestringThe postal ZIP code for the address.7.3.3.5
result.contacts.additionalAddresses.recipientstringThe contact person for the contact address.7.3.3.5
result.contacts.additionalAddresses.stateresult.contacts.additionalAddresses.state{}The state corresponding to the address on record.7.3.3.5
result.contacts.additionalAddresses.state.textstringThe localized display text.7.3.3.5
result.contacts.additionalAddresses.state.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.additionalAddresses.statusresult.contacts.additionalAddresses.status{}The address status indicating whether the address is active or inactive.7.3.3.5
result.contacts.additionalAddresses.status.textstringThe localized display text.7.3.3.5
result.contacts.additionalAddresses.status.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.additionalAddresses.streetAddressstringThe street address. 7.3.3.5
result.contacts.additionalAddresses.streetEndlongThe end of a range of street numbers.7.3.3.5
result.contacts.additionalAddresses.streetNamestringThe street name for the address.7.3.3.5
result.contacts.additionalAddresses.streetPrefixstringAny 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.5
result.contacts.additionalAddresses.streetStartlongThe start of a range of street numbers.7.3.3.5
result.contacts.additionalAddresses.streetSuffixresult.contacts.additionalAddresses.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.3.5
result.contacts.additionalAddresses.streetSuffix.textstringThe localized display text.7.3.3.5
result.contacts.additionalAddresses.streetSuffix.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.additionalAddresses.streetSuffixDirectionresult.contacts.additionalAddresses.streetSuffixDirection{}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.5
result.contacts.additionalAddresses.streetSuffixDirection.textstringThe localized display text.7.3.3.5
result.contacts.additionalAddresses.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.additionalAddresses.typeresult.contacts.additionalAddresses.type{}The address type.7.3.3.5
result.contacts.additionalAddresses.type.textstringThe localized display text.7.3.3.5
result.contacts.additionalAddresses.type.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.additionalAddresses.unitEndstringThe end parameter of a range of unit numbers.7.3.3.5
result.contacts.additionalAddresses.unitStartstringThe starting parameter of a range of unit numbers.7.3.3.5
result.contacts.additionalAddresses.unitTyperesult.contacts.additionalAddresses.unitType{}The unit type designation of the address.7.3.3.5
result.contacts.additionalAddresses.unitType.textstringThe localized display text.7.3.3.5
result.contacts.additionalAddresses.unitType.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.addressresult.contacts.address{}The address of the subject.7.3.3.5
result.contacts.address.addressLine1stringThe first line of the address. 7.3.3.5
result.contacts.address.addressLine2stringThe second line of the address.7.3.3.5
result.contacts.address.addressLine3stringThe third line of the address.7.3.3.5
result.contacts.address.citystringThe name of the city.7.3.3.5
result.contacts.address.countryresult.contacts.address.country{}The name of the country.7.3.3.5
result.contacts.address.country.textstringThe localized display text.7.3.3.5
result.contacts.address.country.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.address.postalCodestringThe postal ZIP code for the address.7.3.3.5
result.contacts.address.stateresult.contacts.address.state{}The state corresponding to the address on record.7.3.3.5
result.contacts.address.state.textstringThe localized display text.7.3.3.5
result.contacts.address.state.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.birthCityresult.contacts.birthCity{}The city of birth for an individual.7.3.3.5
result.contacts.birthCity.textstringThe localized display text.7.3.3.5
result.contacts.birthCity.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.birthDatedateTimeThe birth date of an individual.7.3.3.5
result.contacts.birthRegionresult.contacts.birthRegion{}The country of birth or region of birth for an individual.7.3.3.5
result.contacts.birthRegion.textstringThe localized display text.7.3.3.5
result.contacts.birthRegion.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.birthStateresult.contacts.birthState{}The state of birth for an individual.7.3.3.5
result.contacts.birthState.textstringThe localized display text.7.3.3.5
result.contacts.birthState.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.businessNamestringA secondary business name for the applicable individual.7.3.3.5
result.contacts.commentstringComments or notes about the current context.7.3.3.5
result.contacts.deceasedDatedateTimeThe date of death. This field is active only when the Contact Type selected is Individual.7.3.3.5
result.contacts.driverLicenseNumberstringThe driver's license number of the contact. This field is active only when the Contact Type selected is Individual.7.3.3.5
result.contacts.driverLicenseStateresult.contacts.driverLicenseState{}The state that issued the driver's license.7.3.3.5
result.contacts.driverLicenseState.textstringThe localized display text.7.3.3.5
result.contacts.driverLicenseState.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.emailstringThe contact's email address.7.3.3.5
result.contacts.faxstringThe fax number for the contact.7.3.3.5
result.contacts.faxCountryCodestringFax Number Country Code7.3.3.5
result.contacts.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.3.5
result.contacts.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.genderresult.contacts.gender{}The gender (male or female) of the individual.7.3.3.5
result.contacts.gender.textstringThe localized display text.7.3.3.5
result.contacts.gender.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.5
result.contacts.individualOrOrganizationstringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.3.5
result.contacts.lastNamestringThe last name (surname). 7.3.3.5
result.contacts.middleNamestringThe middle name. 7.3.3.5
result.contacts.organizationNamestringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.3.5
result.contacts.passportNumberstringThe contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.phone1stringThe primary telephone number of the contact. 7.3.3.5
result.contacts.phone1CountryCodestringPhone Number 1 Country Code7.3.3.5
result.contacts.phone2stringThe secondary telephone number of the contact.7.3.3.5
result.contacts.phone2CountryCodestringPhone Number 2 Country Code7.3.3.5
result.contacts.phone3stringThe tertiary telephone number for the contact.7.3.3.5
result.contacts.phone3CountryCodestringPhone Number 3 Country Code7.3.3.5
result.contacts.postOfficeBoxstringThe post office box number.7.3.3.5
result.contacts.preferredChannelresult.contacts.preferredChannel{}The method by which the contact prefers to be notified, by phone for example.7.3.3.5
result.contacts.preferredChannel.textstringThe localized display text.7.3.3.5
result.contacts.preferredChannel.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.raceresult.contacts.race{}The contact's race/ethnicity.7.3.3.5
result.contacts.race.textstringThe localized display text.7.3.3.5
result.contacts.race.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.relationresult.contacts.relation{}The contact's relationship to the application or service request.7.3.3.5
result.contacts.relation.textstringThe localized display text.7.3.3.5
result.contacts.relation.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.salutationresult.contacts.salutation{}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.5
result.contacts.salutation.textstringThe localized display text.7.3.3.5
result.contacts.salutation.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.5
result.contacts.socialSecurityNumberstringThe individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.stateIdNumberstringThe contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.3.5
result.contacts.statusresult.contacts.status{}The contact status.7.3.3.5
result.contacts.status.textstringThe localized display text.7.3.3.5
result.contacts.status.valuestringThe value for the specified parameter.7.3.3.5
result.contacts.suffixstringThe contact name suffix.7.3.3.5
result.contacts.titlestringThe individual's business title. 7.3.3.5
result.contacts.tradeNamestringThe contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.7.3.3.5
result.contacts.typeresult.contacts.type{}The type of people to contact. 7.3.3.5
result.contacts.type.textstringThe localized display text.7.3.3.5
result.contacts.type.valuestringThe value for the specified parameter.7.3.3.5
result.emailstringThe citizen user's email address.7.3.3.4
result.idlong�7.3.3.4
result.passwordstringThe citizen user's password.7.3.3.4
result.questions[]result.questions{}Contains the security questions for password reset.7.3.3.4
result.questions.answerstringThe answer to the security question for password reset.7.3.3.4
result.questions.orderstringThe order of the security question.7.3.3.4
result.questions.questionstringThe security question for password reset. 7.3.3.4
result.receiveSMSstringIndicates whether or not the user prefers to receive SMS messages.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
result.servProvCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.4
result.userNamestringThe user's unique username.7.3.3.4
statusintegerThe record status.7.3.3.4

Example

Sample Response Body

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