Core Shared CROMERR SOAP Services

Available REST services:

https://encromerrdev.epacdxnode.net/shared-cromerr-rest/

Available SOAP services:

Service	Description	WSDL
IdentityProofingService2	Provides an interface to an asynchronous third-party electronic identity proofing service.	https://encromerrdev.epacdxnode.net/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://encromerrdev.epacdxnode.net/shared-cromerr-ws/services/MessagingService?wsdl
SecondFactorAuthenticationService	Allows a user to re-authenticate and answer a knowledge-based question during the signature process.	https://encromerrdev.epacdxnode.net/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://encromerrdev.epacdxnode.net/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://encromerrdev.epacdxnode.net/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://encromerrdev.epacdxnode.net/shared-cromerr-ws/services/UserManagementService?wsdl

IdentityProofingService2

Expand all | Collapse all | Return to top

Provides an interface to an asynchronous third-party electronic identity proofing service.

Authenticate

[+]

Authenticate to the service. The client must be authenticated before subsequent services are invoked.

Parameter Name	Type	Description	Required?	Default Value
adminId	String	User ID	Yes
credential	String	Credential	Yes

CreateActivity

[+]

Creates a CROMERR activity. This activity enables the shared service provider to associate all related CROMERR events such as authentication and signature with a unique transaction ID. It also provides a way to pass specific application properties.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
dataflow	String	Name of the dataflow for this activity	Yes
user	WsUser	User associated with this activity	Yes
properties	WsProperties	Properties to associate with the activity	No

CreateRequest

[+]

Submits an identity proofing request to LexisNexis.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsIdentityProofingFullUser	User for identity proofing	Yes

GetResult

[+]

Gets the result of the LexisNexis identity proofing session that was performed previously.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes

MessagingService

Expand all | Collapse all | Return to top

Defines a way to send out messages to users via SMS or email. Also facilitates sending/validation of PINs for various purposes.

Authenticate

[+]

Authenticate to the service. The client must be authenticated before subsequent services are invoked.

Parameter Name	Type	Description	Required?	Default Value
adminId	String	User ID	Yes
credential	String	Credential	Yes

CreateActivity

[+]

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
dataflow	String	Name of the dataflow for this activity	Yes
user	WsUser	User associated with this activity	Yes
properties	WsProperties	Properties to associate with the activity	No

SendMessage

[+]

Sends a message via SMS or email.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
message	WsMessage	Message and destination	Yes

ValidatePin

[+]

Validates a PIN that was previously sent.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
pin	String	PIN entered by user	Yes

SecondFactorAuthenticationService

Expand all | Collapse all | Return to top

Allows a user to re-authenticate and answer a knowledge-based question during the signature process.

AnswerQuestion

[+]

Send the user's answer to the randomly selected question that was sent back via the GetQuestion service.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the question	Yes
answer	WsAnswer	User's answer	Yes

AuditEvent

[+]

Submit various events performed on the client side related to signature process such as user authentication, signature storage, etc.

Parameter Name	Type	Description	Required?
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

Authenticate

[+]

Authenticate to the service. The client must be authenticated before subsequent services are invoked.

Parameter Name	Type	Description	Required?	Default Value
adminId	String	User ID	Yes
credential	String	Credential	Yes

AuthenticateUser

[+]

Used to authenticate the user who wishes to gain access to the CROMERR second factor shared services environment.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
userId	String	User ID of the end user	Yes
password	String	Password chosen by the user during registration	Yes

CreateActivity

[+]

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
dataflow	String	Name of the dataflow for this activity	Yes
user	WsUser	User associated with this activity	Yes
properties	WsProperties	Properties to associate with the activity	No

GetQuestion

[+]

Request to send back one question from the pool of questions for second factor authentication

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the question	Yes

SignatureAndCorService2

Expand all | Collapse all | Return to top

Allows a user to sign a document and subsequently validate the copy of record (COR) against the generated signature.

AuditEvent

[+]

Submit various events performed on the client side related to signature process such as user authentication, signature storage, etc.

Parameter Name	Type	Description	Required?
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

Authenticate

[+]

Authenticate to the service. The client must be authenticated before subsequent services are invoked.

Parameter Name	Type	Description	Required?	Default Value
adminId	String	User ID	Yes
credential	String	Credential	Yes

CreateActivity

[+]

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
dataflow	String	Name of the dataflow for this activity	Yes
user	WsUser	User associated with this activity	Yes
properties	WsProperties	Properties to associate with the activity	No

DownloadCor

[+]

Retrieves a document with the specified ID.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the document	Yes
documentId	String	CROMERR document ID	Yes

DownloadSignature

[+]

Download the detached signature for a previously signed document.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the document	Yes
documentId	String	CROMERR document ID	Yes

GetActivityHistoryDetail

[+]

Retrieve details about the specified activity.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes

GetSignatureHistory

[+]

Retrieve signature event history for the specified activity.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes

RepudiateCor

[+]

Repudiates a document with the specified ID.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the repudiation	Yes
documentId	String	CROMERR document ID	Yes
info	WsRepudiationInfo	Reason for repudiation	Yes

SearchForActivityHistorySummary

[+]

Search for a summary of activities.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
searchCriteria	WsCorSearchCriteria	Search criteria	Yes

SetCorRetentionStatus

[+]

Set the status for a document with the specified ID.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User who is setting the status	Yes
documentId	String	CROMERR document ID	Yes
status	WsRetentionStatus	Status to set	Yes

SignAndStoreCor

[+]

Sign a copy of record against the specified activity and store it in the archive.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the signing	Yes
notifications	WsNotifications	Email addresses to send notifications to upon signing. Can be any email address.	Yes
document	WsDocument	The document to sign	Yes
signatureData	WsSignatureData	Signature data. Only required if your users are managed externally (i.e. if you are just signing,and not verifying the user in SCS via the SecondFactorAuthenticationService).	No

StoreCor

[+]

Store a copy of record in the archive.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the document	Yes
notifications	WsNotifications	Email addresses to send notifications to	Yes
document	WsDocument	The document to store	Yes

ValidateCor

[+]

Validates a signed document. The operation will check if the user signed the document and the document was not altered since signing.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the document	Yes
documentId	String	CROMERR document ID	Yes
signatureData	WsSignatureData	Signature data. Only required if your users are managed externally (i.e. if you are just signing,and not verifying the user in SCS via the SecondFactorAuthenticationService).	No

SignatureService2

Expand all | Collapse all | Return to top

Allows a user to sign a document and subsequently validate the copy of record (COR) against the generated signature.

AuditEvent

[+]

Submit various events performed on the client side related to signature process such as user authentication, signature storage, etc.

Parameter Name	Type	Description	Required?
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

Authenticate

[+]

Authenticate to the service. The client must be authenticated before subsequent services are invoked.

Parameter Name	Type	Description	Required?	Default Value
adminId	String	User ID	Yes
credential	String	Credential	Yes

CreateActivity

[+]

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
dataflow	String	Name of the dataflow for this activity	Yes
user	WsUser	User associated with this activity	Yes
properties	WsProperties	Properties to associate with the activity	No

Sign

[+]

Signs a document.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the document	Yes
notifications	WsNotifications	Email addresses to send notifications to upon signing. Can be any email address.	Yes
document	WsDocument	The document to sign	Yes
signatureData	WsSignatureData	Signature data. Only required if your users are managed externally (i.e. if you are just signing,and not verifying the user in SCS via the SecondFactorAuthenticationService).	No

ValidateCor

[+]

Validates a signed document. The operation will check if the user signed the document and the document was not altered since signing.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
activityId	String	CROMERR activity ID	Yes
user	WsUser	User associated with the document	Yes
document	WsDocument	The previously signed document	Yes
detachedSignature	WsDetachedSignature	Detached signature	Yes
signatureData	WsSignatureData	Signature data. Only required if your users are managed externally (i.e. if you are just signing,and not verifying the user in SCS via the SecondFactorAuthenticationService).	No

UserManagementService

Expand all | Collapse all | Return to top

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.

Authenticate

[+]

Authenticate to the service. The client must be authenticated before subsequent services are invoked.

Parameter Name	Type	Description	Required?	Default Value
adminId	String	User ID	Yes
credential	String	Credential	Yes

AuthenticateUser

[+]

Authenticate a user's credentials.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
password	String	Password	Yes

ChangeUserAnswers

[+]

Change a user's knowledge-based questions and answers, and also resets their number of answer attempts.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
answers	List<WsAnswer>	User's new questions and answers	Yes

ChangeUserPassword

[+]

Change a user account's password.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
newPassword	String	User's new password	Yes

ChangeUserStatus

[+]

Allows an administrator to change the status of a user account.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
userId	String	User ID	Yes
status	WsRegisteredUserStatus	User's new status	Yes

CreateBaseUser

[+]

Creates a new base user. Base users do not have knowledge-based questions and answers.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
user	WsRegisteredUser	New user information	Yes

CreateUser

[+]

Creates a new user.

Parameter Name	Type	Description	Required?
securityToken	String	Security token	Yes
user	WsRegisteredUser	New user information	Yes
answers	List<WsAnswer>	New user's knowledge-based questions and answers	Yes

GetEligibleQuestions

[+]

Retrieves all eligible knowledge-based questions.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes

RetrieveUser

[+]

Retrieves a user.

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
userId	String	User ID	Yes

UpdateUserInformation

[+]

Updates user information

Parameter Name	Type	Description	Required?	Default Value
securityToken	String	Security token	Yes
user	WsRegisteredUser	Updated user information	Yes

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 question
String answerText - The text of the user's response to the question

WsEvent

Describes a CROMERR event.

Date date - Event date
WsEventGroup group
WsEventType type
WsEventStatus status

WsEventGroup

CROMERR event group.

Valid values are:

Signature
Authentication
SecondFactor

WsEventStatus

CROMERR event status.

Valid values are:

Success
Failure

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 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
String driverLicenseNumber - (Made available for future use)
String DriverLicenseState - (Made available for future use)

WsMessage

Describes a message to be sent.

WsMessageType type
String destination - Message destination (e.g. phone number or email address)
String body - Message content
Boolean 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.

List<WsProperty> properties

WsProperty

Encapsulates a single key-value pair.

String key - String name for the key
String value - Value for the key

WsRegisteredUser

Defines user profile elements.

String userId - User selected user identification string
String password - User's selected password
String firstName - User's first name
String lastName - User's last name
String middleInitial - User's middle initial
WsRegisteredUserStatus status
String organizationName - Name of the user's organization
String 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 - City
String state - State code (e.g. VA)
String country - Country code (e.g. US)
String zip - ZIP code
String email - User's email address
String phone - User's phone number (digits only)
String phoneExtension - User's phone extension
String fax - User's fax number (digits only)
Date lastLoginDate - Date/time of last user login
Date createdDate - Date/time of user account creation
WsProperties properties - User's properties

WsRegisteredUserStatus

User account status.

Valid values are:

Activated
Deactivated

WsUser

Defines base user profile elements.

String userId - User selected user identification string
String firstName - User's first name
String lastName - User's last name
String middleInitial - User's middle initial

WsCorSearchCriteria

(v2) Defines document search criteria.

String activityId - CROMERR document ID
String dataflow - Dataflow acronym
String userId - User ID
String roleName - Role name
Long roleId - Role ID
String organizationName - Organization name
Long organizationId - Organization ID
String documentId - CROMERR document ID
String documentName - Document name
WsRetentionStatus documentRetentionStatus
Date 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.

String id - CROMERR document ID
String name - Document name
WsDocumentFormat format
Date createdDate - Date document was created
WsRetentionStatus retentionStatus
WsRepudiationInfo repudiationInfo
DataHandler content - Document content

WsDocumentFormat

(v2) Document format

Valid values are:

WsEvent

(v2) Describes a CROMERR event.

Date date - Event date
WsEventGroup group
WsEventType type
WsEventStatus status

WsEventGroup

(v2) CROMERR event group.

Valid values are:

Signature
Authentication
SecondFactor

WsEventStatus

(v2) CROMERR event status.

Valid values are:

Success
Failure

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 category
String value - Text description of the notification type (e.g. email address)

WsNotificationCategory

(v2) Notification category

Valid values are:

WsNotifications

(v2) Encapsulates one or more notifications.

List<WsNotification> notifications

WsProperties

(v2) Encapsulates a collection of key-value pairs.

List<WsProperty> properties

WsProperty

(v2) Encapsulates a single key-value pair.

String key - String name for the key
String 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 password
String questionId - ID of the second factor authentication question the user answered
String 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 string
String firstName - User's first name
String lastName - User's last name
String middleInitial - User's middle initial
WsUserRole role
WsUserOrganization organization

WsUserOrganization

(v2) Defines organization information.

String organizationName - Organization name
Long organizationId - Organization ID

WsUserRole

(v2) Defines role information.

String roleName - Role name
Long roleId - Role ID