Available REST services:
https://encromerr.epa.gov/shared-cromerr-rest/
Available SOAP services:
Service |
Description |
WSDL |
IdentityProofingService2 |
Provides an interface to an asynchronous third-party electronic identity proofing service. | https://encromerr.epa.gov/shared-cromerr-ws/services/IdentityProofingService2?wsdl |
MessagingService |
Defines a way to send out messages to users via SMS or email. Also facilitates sending/validation of PINs for various purposes. | https://encromerr.epa.gov/shared-cromerr-ws/services/MessagingService?wsdl |
SecondFactorAuthenticationService |
Allows a user to re-authenticate and answer a knowledge-based question during the signature process. | https://encromerr.epa.gov/shared-cromerr-ws/services/SecondFactorAuthenticationService?wsdl |
SignatureAndCorService2 |
Allows a user to sign a document and subsequently validate the copy of record (COR) against the generated signature. | https://encromerr.epa.gov/shared-cromerr-ws/services/SignatureAndCorService2?wsdl |
SignatureService2 |
Allows a user to sign a document and subsequently validate the copy of record (COR) against the generated signature. | https://encromerr.epa.gov/shared-cromerr-ws/services/SignatureService?wsdl |
UserManagementService |
Allows client applications to create, update, and manage user accounts for use within the client application, including establishing knowledge-based questions and answers for use during the signature process. | https://encromerr.epa.gov/shared-cromerr-ws/services/UserManagementService?wsdl |
Provides an interface to an asynchronous third-party electronic identity proofing service.
Defines a way to send out messages to users via SMS or email. Also facilitates sending/validation of PINs for various purposes.
SecondFactorAuthenticationService
Allows a user to re-authenticate and answer a knowledge-based question during the signature process.
Allows a user to sign a document and subsequently validate the copy of record (COR) against the generated signature.
Allows a user to sign a document and subsequently validate the copy of record (COR) against the generated signature.
Description: Submit various events performed on the client side related to signature process such as user authentication, signature storage, etc.
WSDL:
https://encromerr.epa.gov/shared-cromerr-ws/services/SignatureService?wsdl
Parameter Name |
Type |
Description |
Required? |
Default Value |
securityToken |
String |
Security token |
Yes |
|
activityId |
String |
CROMERR activity ID |
Yes |
|
event |
WsEvent |
Event to audit |
Yes |
|
user |
WsUser |
User associated with this event |
Yes |
|
Allows client applications to create, update, and manage user accounts for use within the client application, including establishing knowledge-based questions and answers for use during the signature process.
Notes: User ID requirements: must a) consist of at least 8 alphanumeric characters, b) must not be all numeric, and c) allowed special characters: period (.), hyphen (-), underscore (_), at (@). Password requirements: a) consist of at least 8 alphanumeric characters, b) not contain the User ID, c) must not contain the word "password", d) contain only letters and numbers, e) contain at least one lowercase and one uppercase letter, f) contain at least one number, g) begin with a letter, h) cannot use any of the user's previous 10 passwords.
Type Definitions
Definitions for data types that are used in service calls.
WsAnswer
Encapsulates the QuestionId and the text of the answer that the user provides in response.
String | questionId - The unique identifier for the questionString | answerText - The text of the user's response to the question
WsEvent
Describes a CROMERR event.
WsEventGroup
CROMERR event group.
Valid values are:
- Signature
- Authentication
- SecondFactor
WsEventStatus
CROMERR event status.
Valid values are:
WsEventType
CROMERR event type.
Valid values are:
- Authenticate
- GetQuestion
- ValidateAnswer
- SignDetached
- StoreDocument
- DownloadDocument
- DownloadSignature
WsIdentityProofingFullUser
Encapsulates all required user information in order to process LexisNexis.
String | userId - User IDString | firstName - User's first nameString | lastName - User's last nameString | middleInitial - User's middle initialString | mailingAddress1 - Mailing address (line 1)String | mailingAddress2 - Mailing address (line 2)String | city - CityString | state - State code (e.g. VA)String | zip - ZIP codeString | phone - Phone numberString | ssnLast4 - Last 4 digits of user's SSNDate | dob - User's date of birthString | driverLicenseNumber - (Made available for future use)String | DriverLicenseState - (Made available for future use)
WsMessage
Describes a message to be sent.
WsMessageType | typeString | destination - Message destination (e.g. phone number or email address)String | body - Message contentBoolean | sendPin - Specifies whether PIN should be generated. If true, "@PIN@" in message body will be replaced with generated PIN.String | subject - Message subject. Only applies for email.String | from - Message source (e.g. from address). Only applies for email.
WsMessageResult
Describes result of a sent message.
String | messageId - Internal message ID
WsMessageType
Valid message destinations.
Valid values are:
WsProperties
Encapsulates a collection of key-value pairs.
WsProperty
Encapsulates a single key-value pair.
String | key - String name for the keyString | value - Value for the key
WsRegisteredUser
Defines user profile elements.
String | userId - User selected user identification stringString | password - User's selected passwordString | firstName - User's first nameString | lastName - User's last nameString | middleInitial - User's middle initialWsRegisteredUserStatus | statusString | organizationName - Name of the user's organizationString | mailingAddress1 - Mailing address (line 1)String | mailingAddress2 - Mailing address (line 2)String | mailingAddress3 - Mailing address (line 3)String | mailingAddress4 - Mailing address (line 4)String | city - CityString | state - State code (e.g. VA)String | country - Country code (e.g. US)String | zip - ZIP codeString | email - User's email addressString | phone - User's phone number (digits only)String | phoneExtension - User's phone extensionString | fax - User's fax number (digits only)Date | lastLoginDate - Date/time of last user loginDate | createdDate - Date/time of user account creationWsProperties | properties - User's properties
WsRegisteredUserStatus
User account status.
Valid values are:
WsUser
Defines base user profile elements.
String | userId - User selected user identification stringString | firstName - User's first nameString | lastName - User's last nameString | middleInitial - User's middle initial
WsCorSearchCriteria
(v2) Defines document search criteria.
String | activityId - CROMERR document IDString | dataflow - Dataflow acronymString | userId - User IDString | roleName - Role nameLong | roleId - Role IDString | organizationName - Organization nameLong | organizationId - Organization IDString | documentId - CROMERR document IDString | documentName - Document nameWsRetentionStatus | documentRetentionStatusDate | startDate - Date document was created (on or after)Date | endDate - Date document was created (on or before)
WsDetachedSignature
(v2) Encapsulates the detached signature object
DataHandler | content - Signature content (Base64/MTOM)
WsDocument
(v2) Describes document metadata and the content of the document.
(v2) Document format
Valid values are:
WsEvent
(v2) Describes a CROMERR event.
WsEventGroup
(v2) CROMERR event group.
Valid values are:
- Signature
- Authentication
- SecondFactor
WsEventStatus
(v2) CROMERR event status.
Valid values are:
WsEventType
(v2) CROMERR event type.
Valid values are:
- Authenticate
- GetQuestion
- ValidateAnswer
- SignDetached
- StoreDocument
- DownloadDocument
- DownloadSignature
WsNotification
(v2) Describes the type of notification to be sent.
WsNotificationCategory
(v2) Notification category
Valid values are:
WsNotifications
(v2) Encapsulates one or more notifications.
WsProperties
(v2) Encapsulates a collection of key-value pairs.
WsProperty
(v2) Encapsulates a single key-value pair.
String | key - String name for the keyString | value - Value for the key
WsRepudiationInfo
(v2) Information used to repudiate a document.
String | description - Reason for repudiation
WsRetentionStatus
(v2) Retention status. New documents will use the Default status.
Valid values are:
- Default
- HeldForEnforcement
- Repudiated
- Expired
- Rescinded
- Accepted
- Approved
- Pending
- Rejected
WsSignatureData
(v2) Encapsulates the three elements that define the user's signature.
String | passwordSHA256Hash - Hash of the passwordString | questionId - ID of the second factor authentication question the user answeredString | answerSHA256Hash - Hash of the user's answer to second factor authentication question
WsUser
(v2) Defines base user profile elements.
String | userId - User selected user identification stringString | firstName - User's first nameString | lastName - User's last nameString | middleInitial - User's middle initialWsUserRole | roleWsUserOrganization | organization
WsUserOrganization
(v2) Defines organization information.
String | organizationName - Organization nameLong | organizationId - Organization ID
WsUserRole
(v2) Defines role information.
String | roleName - Role nameLong | roleId - Role ID