Available SOAP services:

Service	Description	WSDL
RegisterAuthService	Authenticate against CDX.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterAuthService?wsdl
RegisterDirectoryService	Specific services for retrieving users via Role IDs.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterDirectoryService?wsdl
RegisterErrorService	Retrieve error codes returned by CDX registration services.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterErrorService?wsdl
RegisterIdentityProofingService	Perform identity proofing via LexisNexis.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterIdentityProofingServiceConditionalMTOM?wsdl
RegisterInboxService	Create CDX inbox messages.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterInboxServiceConditionalMTOM?wsdl
RegisterLinkService	Creates a deep link to a page within a CDX application.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterLinkService?wsdl
RegisterMyCdxService	Retrieve information seen in MyCDX, such as application links and alerts.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterMyCdxService?wsdl
RegisterPaymentService	Send user payments to a payment processor (e.g. Pay.gov) and query those payments.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterPaymentService?wsdl
RegisterPdfService	Generate PDFs, including PDFs of pages within CDX applications.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterPdfServiceConditionalMTOM?wsdl
RegisterProgramFacilityService	Various services for retrieving & managing facility information and facility associations to CDX users.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterProgramFacilityService?wsdl
RegisterProgramIdService	Manage Program ID values used by a program within CDX registration.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterProgramIdService?wsdl
RegisterReviewService	Download and review documents in CROMERR.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterReviewerServiceConditionalMTOM?wsdl
RegisterService	Various services for manipulating users, roles, organizations, etc.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterService?wsdl
RegisterSignService	Various services for signing and retrieving documents in CROMERR.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterSignService?wsdl
RegisterSponsorshipService	Retrieve sponsorship details.	https://devngn.epacdxnode.net/cdx-register-II/services/RegisterSponsorshipService?wsdl
StreamlinedRegistrationService	Various services for manipulating users, roles, organizations, etc.	https://devngn.epacdxnode.net/cdx-register-II/services/StreamlinedRegistrationService?wsdl

---

Authenticate against CDX.

---

Specific services for retrieving users via Role IDs.

---

Retrieve error codes returned by CDX registration services.

---

Perform identity proofing via LexisNexis.

---

Create CDX inbox messages.

---

Creates a deep link to a page within a CDX application.

Notes: Generated link will prompt the user to login if necessary, choose their role (if the user has multiple roles for the same Role ID), then handoff. Useful for, example, email notifications.

---

Retrieve information seen in MyCDX, such as application links and alerts.

---

Send user payments to a payment processor (e.g. Pay.gov) and query those payments.

---

Generate PDFs, including PDFs of pages within CDX applications.

---

Various services for retrieving & managing facility information and facility associations to CDX users.

---

Manage Program ID values used by a program within CDX registration.

---

Download and review documents in CROMERR.

---

Various services for manipulating users, roles, organizations, etc.

---

Various services for signing and retrieving documents in CROMERR.

---

Retrieve sponsorship details.

---

Various services for manipulating users, roles, organizations, etc.

---

Type Definitions

Definitions for data types that are used in service calls.

---

IdentityProofingDocument

Represents result of identity proofing.

• String documentId - CROMERR document ID
• String name - Document name
• IdentityProofingDocumentFormat format
• DataHandler content - Document content

---

IdentityProofingDocumentFormat

Identity proofing result format.

Valid values are:

• XML
• JSON

---

IdentityProofingResult

Represents result of identitiy proofing.

• String activityId - CROMERR activity ID
• IdentityProofingDocument rawResults - Raw results returned from identity proofing
• IdentityProofingSummaryResult summaryResult - User's electronic verification index, determined from identity proofing result
• String summaryResultDescription - Electronic verification index description

---

IdentityProofingSummaryResult

User's electronic verification index, determined from identity proofing result.

Valid values are:

• CROMERR_Minimum
• CROMERR_Exceeded
• CROMERR_NotMet

---

IdentityProofingUser

Represents user being identity proofed with name, address, etc.

• String userId - User ID
• String firstName - User's first name
• String lastName - User's last name
• String middleInitial - User's middle initial
• String mailingAddress1 - Mailing address (line 1)
• String mailingAddress2 - Mailing address (line 2)
• String city - City
• String state - State code (e.g. VA)
• String zip - ZIP code
• String phone - Phone number
• String ssnLast4 - Last 4 digits of user's SSN
• Date dob - User's date of birth (YYYY-MM-DD)
• Long userRoleId - User role ID

---

InboxAttachment

Represents a CDX inbox attachment.

• DataHandler content - Content
• String name - Attachment name

---

InboxAttachments

Represents one or more CDX inbox message attachments.

• List<InboxAttachment> attachments - One or more attachments

---

HandoffType

Application handoff type. NONE = no handoff, LEGACY = LegacyCDX handoff, RSO = NaasToken handoff

Valid values are:

• NONE
• LEGACY
• RSO

---

HandoffUser

Handoff information passed to an application.

• String userId - User ID
• String email - Email address
• String title - Title (Mr, Ms, etc.)
• String firstName - First name
• String lastName - Last name
• String middleInitial - Middle initial
• String suffix - Suffix (Jr, III, etc.)
• String address1 - Mailing address (line 1)
• String address2 - Mailing address (line 2)
• String address3 - Mailing address (line 3)
• String address4 - Mailing address (line 4)
• String city - City
• String state - State code (e.g. VA)
• String country - Country code (e.g. US
• String postalCode - ZIP code
• String organization - Organization name
• String phoneNumber - Phone number (digits only)
• String phoneExtension - Phone extension
• Long userOrganizationId - User organization ID
• Long organizationId - Organiation ID
• String dataflowName - Dataflow name
• Integer idTypeCode - Role ID
• String IdTypeText - Role name
• Long userRoleId - User role ID
• Long roleId - Role ID
• String clientId - Program ID (aka Client ID, aka Subject)
• String roleStatus - User role status

---

PdfDocument

Document returned by PDF service.

• DataHandler content

---

DocumentIds

Represents one or more CROMERR document IDs.

• List<String> documentIds - One or more document IDs

---

RepudiationStatus

Document repudiation status.

Valid values are:

• Default
• Rescinded
• HeldForEnforcement
• Repudiated
• Expired
• Accepted
• Approved
• Pending
• Rejected

---

ReviewActivity

Represents a CROMERR activity.

• String activityId - CROMERR activity ID
• String dataflow - Dataflow acronym
• Date createdDate - Activity creation date
• String userId - User ID
• List<ReviewDocument> documents

---

ReviewDocument

Represents a CROMERR document.

• DataHandler content - Document content
• String name - Document name
• String id - CROMERR document ID

---

ReviewSearchCriteria

Represents search criteria for searching CROMERR activities.

• String activityId - CROMERR activity ID
• String dataflow - Dataflow acronym
• String userId - User ID
• Date startDate - Start date of activity
• Date endDate - End date of activity

---

ReviewerUser

Represents a user repudiating a CROMERR document.

• String userId - User ID
• String firstName - First name
• String lastName - Last name
• String middleInitial - Middle initial
• String organizationName - Organization name

---

SubmissionsIds

Represents one or more CROMERR submission (activity) IDs.

• List<String> submissionIds - One or more submission IDs

---

ActivityAcl

Represents a ACL (access control list) for a CROMERR activity.

• String roleId - Role ID
• String roleDescription - Role name
• String subject - Program ID (aka Client ID, aka Subject)

---

ActivityAcls

Represents one or more ACLs (access control list) for a CROMERR activity.

• List<ActivityAcl> activityAcls - One or more ACLs

---

ActivityTag

Represents a metadata tag (value) for a CROMERR activity.

• String value

---

ActivityTags

Represents one or more metadata tags (values) for a CROMERR activity.

• List<ActivityTag> activityTags - One or more tags (values)

---

Properties

Represents one or more properties (name-value pairs) for a CROMERR activity.

• List<Property> properties - One or more properties

---

Property

Represents a property (name-value pair) for a CROMERR activity.

• String key
• String value

---

Question

Represents a 20-5-1 question.

• String questionId - Question ID
• String text - Question text

---

SecondFactorType

Second factor type.

Valid values are:

• PAY_GOV_LEXIS
• PIV_CARD

---

SecretCodeType

Secret code type.

Valid values are:

• SMS

---

SignatureDocument

Represents a signed document in CROMERR.

• String name - Document name
• SignatureDocumentFormatType format - Document format
• DataHandler content - Content

---

SignatureDocumentFormatType

CROMERR document format.

Valid values are:

• XML
• BIN

---

SignatureUser

Represents a user signing a document in CROMERR.

• String userId - User ID
• String firstName - First name
• String lastName - Last name
• String middleInitial - Middle initial
• String organizationName - Organization name

---

RegistrationProgramFacilityBiaCode

Represents a facility BIA code.

• String biaCode - BIA code
• String epaId - EPA registry ID
• String stateCode - State code (e.g. VA)
• String tribeName - Tribe name

---

SearchMatchType

Search type for text fields.

Valid values are:

• CONTAINS
• EXACT
• STARTS_WITH

---

RegisterBankAccountType

Type of bank account.

Valid values are:

• BUSINESS_CHECKING
• BUSINESS_SAVINGS
• PERSONAL_CHECKING
• PERSONAL_SAVINGS

---

RegisterGetConfigResponse

Represents an application's configuration within the payment service.

• List<Account> accounts

---

Account

Represents an account within a payment service application.

• String accountId - Account ID
• String description - Account description
• RegisterProcessorType processor - Payment processing service to use (e.g. Pay.gov)
• List<RegisterSendPaymentType> paymentTypes
• List<RegisterLabelValue> customFields

---

RegisterLabelValue

Represents a label-value pair, i.e. an arbitrary field name and its value.

• String label - Field name
• String value - Field value

---

RegisterProcessorStatusResponse

Represents payment processing service status.

• RegisterProcessorStatusType status - Status
• String statusDetail - Status detail

---

RegisterProcessorStatusType

Payment processing service status.

Valid values are:

• AVAILABLE
• NOT_AVAILABLE

---

RegisterProcessorType

Payment processing service.

Valid values are:

• PAY_GOV

---

RegisterQueryPaymentRequest

Criteria for searching payments.

• String trackingNumber - Tracking number assigned by payment service (e.g. DPSTSCA000001)
• String transactionId - Transaction ID (e.g. from Pay.gov)

---

RegisterQueryPaymentResponse

Represents search result from the payment service.

• RegisterQueryPaymentStatusType status - Whether the payment exists or not
• String statusDetail - Status detail
• String transactionStatus - Payment processor transaction status
• String transactionStatusDetail - Payment processor transaction status detail
• Date date - Payment date
• String processorRequest - Raw request sent to payment processor when payment was sent. Certain information may be hashed.
• String processorResponse - Raw response received from payment processor when payment was sent. Certain information may be hashed.
• String processorDataFormat - Data format for payment processor request and response (e.g. XML)

---

RegisterQueryPaymentStatusType

Represents whether a payment exists.

Valid values are:

• FOUND
• NOT_FOUND

---

RegisterSendPaymentRequest

Used for sending a payment to the payment service.

• Double amount - Payment amount
• RegisterSendPaymentType paymentType
• String firstName - First name
• String lastName - Last name
• String companyName - Company name
• String email - Email address
• String accountNumber - Account number (e.g. bank account number or credit card number
• List<RegisterLabelValue> customFields - Custom fields. These will be sent to the payment processor (e.g. Pay.gov).
• List<RegisterLabelValue> emailReceiptFields - Email receipt fields. These are only used for the email notification sent to the payer.
• String trackingNumber - Tracking number assigned by application, if applicable
• RegisterBankAccountType accountType
• String routingNumber - Bank account routing number
• String checkNumber - Check number
• String billingAddress - Billing address (line 1)
• String billingAddress2 - Billing address (line 2)
• String billingCity - Billing city
• String billingState - Billing state
• String billingZip - Billing ZIP code
• RegisterLabelValue billingCountry - Billing country (both country code and name)
• Integer expirationMonth - Month of credit card expiration date
• Integer expirationYear - Year of credit card expiration date
• String ccv - CCV code (aka security code)

---

RegisterSendPaymentResponse

Response received when sending a payment to the payment service.

• String trackingNumber - Tracking number assigned by application or payment service
• String transactionId - Transaction ID assigned by payment processor
• RegisterSendPaymentStatusType status - Whether the payment was successful or not
• String statusDetail - Status detail
• String transactionStatus - Transaction status
• Date date - Payment date
• String accountNumberMasked - Account number (masked)
• Double amount - Payment amount (US dollars)
• Date effectiveDate - (Pay.gov + bank account only) Payment effective date
• String approvalCode - (Pay.gov + credit card only) Approval code
• String authCode - (Pay.gov + credit card only) Authorization code
• String authDetail - (Pay.gov + credit card only) Authorization detail
• String addressCode - (Pay.gov + credit card only) Address code
• String cardCode - (Pay.gov + credit card only) Card code
• Double authorizedAmount - (Pay.gov + credit card only) Authorized amount (US dollars)
• Double remainingBalance - (Pay.gov + credit card only) Remaining balance (US dollars)
• String processorRequest - Raw request sent to payment processor when payment was sent. Certain information may be hashed.
• String processorResponse - Raw response received from payment processor when payment was sent. Certain information may be hashed.
• String processorDataFormat - Data format for payment processor request and response (e.g. XML)

---

RegisterSendPaymentStatusType

Represents whether a payment was successful.

Valid values are:

• SUCCESS
• FAILURE

---

RegisterSendPaymentType

Type of payment.

Valid values are:

• BANK_ACCOUNT
• CREDIT_CARD

---

NaicsPrimaryIndicator

Represents type of NAICS code.

Valid values are:

• PRIMARY
• SECONDARY
• UNKNOWN

---

RegistrationAnswer

Represents question and answer for security questions or CROMERR 20-5-1 questions.

• RegistrationQuestion question
• String answer - User-provided answer

---

RegistrationBounceback

Represents a bounceback email.

• Long id - Internal ID
• String dataflow - Dataflow acronym
• RegistrationRoleType role
• String mailbox - Mailbox, i.e. From address for email that was bounced back to, e.g. noreply-dev@epacdx.net
• String badEmailAddress - Invalid email address(es) that were attempted to be delivered to
• Date date - Date of email
• String subject - Email subject
• String reason - Reason for bounceback
• String statusCode - Bounceback status code
• String statusDetail - Bounceback status detail
• List<RegistrationBouncebackHeader> customHeaders - Custom headers captured from the email

---

RegistrationBouncebackHeader

Represents a single custom header captured from a bounceback email.

• String name - Header name (e.g. X-DataflowAcronym)
• String value - Header value

---

RegistrationBouncebackSearchCriteria

Criteria when searching bounceback emails.

• String dataflow - Dataflow acronym
• Long roleId - Role ID
• String mailbox - Mailbox, i.e. From address for email that was bounced back to, e.g. noreply-dev@epacdx.net
• String badEmailAddress - Invalid email address(es) that were attempted to be delivered to ("contains" search)
• Date startDate - Start date of email
• Date endDate - End date of email
• List<RegistrationBouncebackHeader> customHeaders - Custom headers captured from the email. If multiple header criteria are specified, values for same header name will do "OR" search, values across different header names will do "AND" search.

---

RegistrationConfirmation

Represents a generated confirmation code.

• String userId - User ID
• String email - Email address
• String code - Confirmation code
• Long userRoleId - User role ID
• Date expiration - Date that confirmation code expires

---

RegistrationCountry

Represents a country.

• String code - Country code (e.g. US)
• String name - Country name

---

RegistrationDataflow

Represents a dataflow within CDX.

• Long dataflowId - Internal ID
• String acronym - Acronym
• String name - Name
• String status - Status. One of: Active, OfflineTemporary, OfflinePermanent
• String categoryAcronym - Category acronym
• String categoryName - Category name

---

RegistrationFacility

Represents a facility within CDX.

• Long number - CDX facility ID
• String epaRegistryId - EPA registry ID
• String name - Facility name
• String address - Mailing address (line 1)
• String address2 - Mailing address (line 2)
• String city - City
• String state - State code (e.g. VA)
• String county - County
• String zipCode - ZIP code
• Double latitude - Latitude
• Double longitude - Longitude
• List<RegistrationFacilityProgram> programs
• List<RegistrationFacilityMailingAddress> mailingAddresses

---

RegistrationFacilityMailingAddress

Represents additional mailing addresses for a CDX facility.

• String dataflow - Dataflow acronym
• String dataflowFacilityId - Dataflow facility ID
• String dataflowFacilityName - Facility name
• String affiliationType - Affiliation type
• String address - Mailing address (line 1)
• String address2 - Mailing address (line 2)
• String city - City
• String state - State code (e.g. VA
• String zip - ZIP code
• String country - Country code (e.g. US

---

RegistrationFacilityProgram

Represents a program that a facility applies to.

• String id - Program ID
• String name - Program name

---

RegistrationNewUserProfile

Represents a new user.

• RegistrationUser user
• RegistrationOrganization organization
• RegistrationRole role
• List<RegistrationAnswer> secretAnswers
• List<RegistrationAnswer> electronicSignatureAnswers
• RegistrationUserMobile userMobile
• List<RegistrationRoleDataElement> roleElements

---

RegistrationOrganization

Represents organization properties.

• String organizationName - Organization name
• String mailingAddress1 - Mailing address (line 1)
• String mailingAddress2 - Mailing address (line 2)
• String city - City
• RegistrationState state
• RegistrationCountry country
• String zip - ZIP code
• String email - Email address
• String phone - Phone number (digits only)
• String phoneExtension - Phone extension
• String fax - Fax number (digits only)
• Boolean primaryOrg - Indicates if this is the user's primary organization
• String mailingAddress3 - Mailing address (line 3)
• String mailingAddress4 - Mailing address (line 4)
• Long userOrganizationId - User organization ID
• Long organizationId - Organization ID
• String cdxEsaStatus - CDX ESA status

---

RegistrationPreRegistration

Represents a pre-registration record (CRK).

• String crk - CRK (aka Customer Retrieval Key)
• String crkStatus - CRK status
• String nominatorUserId - Nominator's user ID
• RegistrationUser user - User information
• RegistrationOrganization organization - Organization information
• String dataflow - Dataflow acronym
• Long roleId - Role ID
• String subject - Program ID (aka Client ID, aka Subject)
• Long userRoleId
• Date createDate

---

RegistrationProfileUpdate

Represents an update to a user's organization-specific information.

• Long userOrganizationId - User organization ID
• String email - Email address
• String phone - Phone number (digits only)
• String phoneExtension - Phone extension
• String fax - Fax number (digits only)
• Boolean suppressNotification - Indicates whether the user should be notified when this update is applied

---

RegistrationProfileUpdateRequest

Represents a request to update to a user's organization-specific information.

• Long userOrganizationId - User organization ID
• String email - New email address
• String phone - New phone number (digits only)
• String phoneExtension - New phone extension
• String fax - New fax number (digits only)
• String userId - User ID
• String currentEmail - Current email address
• String currentPhone - Current phone number (digits only)
• String currentPhoneExtension - Current phone extension
• String currentFax - Current fax number (digits only)
• String code - Verification code
• Date codeExpirationDate - Verification code expiration date
• Boolean deleteExtension - Indicates whether phone extension should be removed
• Boolean deleteFax - Indicates whether fax number should be removed
• Date createdDate - Request creation date
• Date updatedDate - Request updated date

---

RegistrationProgramFacility

Represents a facility within CDX.

• Long id - CDX facility ID
• String epaRegistryId - EPA registry ID
• String name - Facility name
• String address - Mailing address (line 1)
• String address2 - Mailing address (line 2)
• String city - City
• String state - State code (e.g. VA)
• String county - County
• String zipCode - ZIP code
• Double latitude - Latitude
• Double longitude - Longitude
• RegistrationProgramFacilityType type
• String program - Program acronym
• String programId - Program ID
• String stateFacilityId - State-specific facility ID
• String responsibleAgency - Name of agency, tribe or state that governs the facility
• String biaCode - BIA code
• Boolean federal - Indicates if this is a federal facility
• List<RegistrationProgramFacilityMailingAddress> mailingAddresses
• String additionalProgramList - Additional program acronyms
• String alternateRegistryIdList - Alternate registry IDs
• String collectionMethod - Collection method
• String referencePoint - Reference point
• Integer accuracy - Accuracy
• Integer scale - Scale
• String countyFIPSCode - FIPS county code
• String facilityType - Represents if this facility is Federal, GOCO, or Neither
• List<RegistrationProgramFacilityNaicsCode> naicsCodes
• String stateName - State name
• String countryName - Country name
• String npdesList - NPDES IDs
• String countryCode - Country code (e.g. US)

---

RegistrationProgramFacilityMailingAddress

Represents additional mailing addresses for a CDX facility.

• Long id - Internal ID
• Long cdxFacilityId - CDX facility ID
• String address1 - Mailing address (line 1)
• String address2 - Mailing address (line 2)
• String city - City
• String stateCode - State code (e.g. VA
• String county - County
• String zip - ZIP code
• String facilityName - Facility name
• String affiliationType - Affiliation type
• String program - Program acronym
• String programId - Program ID
• String countryName - Country name
• String stateName - State name
• String countryCode - Country code (e.g. US

---

RegistrationProgramFacilityNaicsCode

Represents NAICS codes associated with a CDX facility.

• Long id - Internal ID
• Long cdxFacilityId - CDX facility ID
• String code - Code
• String description - Code description
• NaicsPrimaryIndicator primaryIndicator

---

RegistrationProgramFacilitySearchCriteria

Criteria for searching CDX facilities.

• String programAcronym - Program acronym
• Boolean mailingAddresses - Indicates if additional mailing addresses should be returned in results
• Long limit - Maximum number of results to return
• String registryId - EPA registry ID
• String facilityName - Facility name
• String streetAddress - Mailing address
• String city - City
• String state - State code (e.g. VA)
• String zipCode - ZIP code
• String county - County
• String stateName - State name
• String countryName - Country name
• Boolean naicsCodes - Indicates if NAICS codes should be returned in results
• Boolean excludeDuplicates - Indicates if duplicates should be excluded from results

---

RegistrationProgramFacilityType

Represents type of CDX facility.

Valid values are:

• MASTER
• PROGRAM

---

RegistrationQuestion

Represents a single security question or CROMERR 20-5-1 question.

• Long id - Question ID
• String text - Question text
• String useType - Question use. One of: SECRET QUESTION, CROMERR 20-5-1

---

RegistrationRole

Represents a user role.

• Long userRoleId - User role ID
• String dataflow - Dataflow acronym
• RegistrationRoleStatus status
• RegistrationRoleType type
• String subject - Program ID (aka Client ID, aka Subject)

---

RegistrationRoleDataElement

Represents additional data elements associated to a user role.

• Long id - Internal ID
• String value - Element value
• RegistrationRoleTypeDataElement element - Element type

---

RegistrationRoleSearchCriteria

Criteria when searching roles.

• List<String> dataflowCategories - One or more dataflow category acronyms
• String email - Email address

---

RegistrationRoleSponsorship

Represents a user's status in regards to sponsorship.

• Long userRoleSponsorshipId - Internal ID
• String userId - User ID of sponsor (primary)
• Long userRoleId - User role ID of sponsor (primary)
• Long organizationId - Organization ID of sponsor (primary)
• RegistrationRoleSponsorshipStatus status - Status of sponsor (primary)
• String comments
• Date updatedTime
• Long requestorUserRoleId - User role ID of sponsoree (secondary)

---

RegistrationRoleSponsorshipStatus

Represents sponsor's status.

• String code - Status code
• String description - Status description
• String name - Status name

---

RegistrationRoleStatus

Represents status of a user role.

• String code - Status code
• String description - Status description

---

RegistrationRoleType

Represents a CDX role within a specific dataflow.

• Long code - Role ID
• String description - Role name
• String status - Role status
• String esaRequirement - CDX ESA requirement for the role
• Boolean signatureQuestionsRequired - Indicates if the role requires CROMERR 20-5-1 questions
• Boolean manageFacilities - Indicates if the role allows user to manage facilities associated to their role

---

RegistrationRoleTypeDataElement

Represents a type of data element that can be associated to a user role.

• Long id - Internal ID
• String code - Element type code
• String name - Element name
• Boolean required - Indicates if the element is required
• Long sortOrder - Element sort order (CDX Web use only)
• RegistrationRoleTypeDataSection section - Element section (CDX Web use only)

---

RegistrationRoleTypeDataSection

CDX Web use only.

• Long id
• String code
• String name
• Boolean showHeader
• Long sortOrder

---

RegistrationState

Represents a state.

• String code - State code (e.g. VA)
• String name - State name
• Long region
• String countryCode

---

RegistrationUser

Represents basic properties of a CDX user account.

• String userId - User ID
• String firstName - First name
• String lastName - Last name
• String middleInitial - Middle initial
• RegistrationUserSuffix suffix - Suffix (Jr, III, etc.)
• RegistrationUserTitle title - Title (Mr, Ms, etc.)
• String password
• Date lastLogin - Last login date
• String oidcUpstreamProvider
• String oidcUpstreamId
• Date registrationDate - Registration date
• Long verificationIndexElectronic - LexisNexis verification index (electronic)
• Long verificationIndexPaper - LexisNexis verification index (paper)
• Long passwordResetAttempts - Number of password reset attempts
• Long lexisNexisAttempts - Number of LexisNexis attempts
• String status - Account status

---

RegistrationUserMobile

Represents a mobile number associated to a user.

• String mobilePhone - Phone number
• String verificationCode - Hash of verification code sent when the number was verified
• Date verificationCodeSentDate - Date verification code was sent
• Date verificationDate - Date number was verified by the user
• String verificationMessageId - Internal message ID for the text sent with the verification code
• RegistrationUserMobileStatus mobileStatus
• Boolean primaryIndicator - Indicates if this is the user's primary mobile number

---

RegistrationUserMobileResponse

Represents a sent text message.

• String userId - User ID
• String mobilePhone - Phone number (digits only)
• String messageId - Internal ID of message
• Date sent - Message sent date

---

RegistrationUserMobileStatus

Mobile number status

Valid values are:

• VERIFIED
• UNVERIFIED

---

RegistrationUserQuestionsStatus

Represents status of user's CROMERR 20-5-1 questions.

• Boolean exist - Indicates if the user has questions on file
• Boolean locked - Indicates if the user's CROMERR attempts are currently locked

---

RegistrationUserSearchCriteria

Criteria for searching users.

• String userId - User ID (single)
• List<String> userIds - User ID (multiple, "OR" search
• SearchMatchType userMatchType - Search mode for user ID searches
• String firstName - First name
• String lastName - Last name
• String middleInitial - Middle initial
• Long organizationId - Organization ID
• String organizationName - Organization name
• String organizationAddress - Organization mailing address
• String email - Email address
• String dataflow - Dataflow acronym
• RegistrationRoleType roleType - Role ID (single)
• List<RegistrationRoleType> roleTypes - Role ID (multiple, "OR" search
• RegistrationRoleStatus roleStatus
• String subject - Program ID (aka Client ID, aka Subject)
• Long userRoleId - User role ID

---

RegistrationUserSearchResult

Represents paginated user search results.

• List<RegistrationNewUserProfile> results
• Long totalCount - Total number of results
• Long rowId - Current result
• Long maxRows - Number of results per page
• String sortOrder - Sort order

---

RegistrationUserSuffix

Represents a user's name suffix (Jr, III, etc.).

• String description

---

RegistrationUserTitle

Represents a user's title (Mr, Ms, etc.).

• String description

---

RegisterError

Represents an error returned by registration services.

• String errorCode
• String errorMessage
• String serviceName
• String errorCodeUnique

---

RegistrationUserRoleProgramFacility

Represents association between a user and a facility.

• Long userFacilityId - Internal ID
• String userId - User ID
• Long userRoleId - User role ID
• Long cdxFacilityId - CDX facility ID
• String epaRegistryId - Facility EPA registry ID

---

RegistrationUserSecondFactorMethod

Represents type (i.e. method of delivery) of second factor.

Valid values are:

• SMS

---

RegistrationAnnouncement

Represents a published announcement (aka alert).

• RegistrationAnnouncementType type
• List<RegistrationAnnouncementLocation> locations
• String partnerId
• String dataflow - Dataflow acronym
• Long roleId - Role ID
• Date startDate - Start date of alert
• Date endDate - End date of alert
• String text - Alert text

---

RegistrationAnnouncementLocation

Alert location

Valid values are:

• CDX_WEB
• APPLICATION
• EEP

---

RegistrationAnnouncementSearchCriteria

Criteria for searching announcements (aka alerts).

• String type - Alert type. Must be one of: Alerts, NewsAndUpdates, HomePage, RecentAnnouncements
• String location - Alert location. Must be one of: CDXWeb, Application, EEnterprisePortal
• String userId - User ID who published the alert
• String dataflow - Dataflow acronym
• Long roleId - Role ID
• Date startDate - Start date of alert
• Date endDate - End date of alert

---

RegistrationAnnouncementType

Alert type

Valid values are:

• ALERTS
• NEWS_AND_UPDATES
• HOME_PAGE
• RECENT

---

RegistrationMyCdxLink

Represents a link to an application, as used by MyCDX.

• Long roleId - Role ID
• String dataflowAcronym - Dataflow acronym
• String dataflowName - Dataflow name
• RegistrationRoleStatus status
• String description - Application description
• String categoryAcronym - Dataflow category acronym
• String categoryName - Dataflow category name
• Boolean eepIntegration - Indicates if E-Enterprise Portal will show this application when the user logs into the Portal
• String roleName
• String handoffUrl
• Boolean mergeRoles
• Boolean categoryEnabled

---

RegistrationMyCdxLinkDetail

Represents details of an application link, as used by MyCDX.

• Long userRoleId - User role ID
• Long userOrganizationId - User organization ID
• String organizationName - Organization name
• String subject - Program ID (aka Client ID, aka Subject)
• RegistrationRoleStatus roleStatus
• String roleName - Role name

---

RegistrationMyCdxLinkHandOff

Represents handoff details of an application link, as used by MyCDX.

• Long userRoleId - User role ID
• String handOffUrl - Handoff URL
• List<RegistrationMyCdxLinkHandOffParameter> parameters

---

RegistrationMyCdxLinkHandOffParameter

Represents handoff parameters for an application link, as used by MyCDX.

• String name
• String value

---

PdfRenderingEngine

Rendering engine used to generate the PDF.

Valid values are:

• PHANTOM_JS
• PHANTOM_JS_2
• HEADLESS_CHROME

---

CdxDeepLink

Represents a deep link within a CDX application.

• String applicationUrl - Application URL
• CdxDeepLinkUrlType applicationUrlType
• Long roleId - Role ID
• Long userRoleId - User role ID

---

CdxDeepLinkUrlType

Type of application URL for deep linking.

Valid values are:

• Absolute
• RelativeNgn
• RelativeCdx

---