Request Information

URI Parameters

None.

Body Parameters

The VOE request.

Nano.VOERequest
NameDescriptionTypeAdditional information
appId

Gets or sets the app identifier.

 integer

None.
employeeAltId

Gets or sets the employeeAltId.

 string

None.
employerCode

Gets or sets the EmployerCode.

 string

None.
employerId

Gets or sets the employer identifier.

 integer

None.
message

Gets or sets the message.

 string

None.
personId

Gets or sets the person identifier.

 integer

None.
provider

Gets or sets the provider.

 ProviderEnum

None.
receiverEmails

Gets or sets the receiver emails.

 Collection of string

None.
referenceIdentifier

Gets or sets the reference identifier.

 string

None.
salaryKey

Gets or sets the SalaryKey.

 string

None.
verificationOrderId

Gets or sets the verification order identifier.

 integer

None.
verificationOrderTypeCode

Gets or sets the verificationOrderTypeCode.

 string

None.
verificationType

Gets or sets the verification type.

 VerificationTypeEnum

None.

Request Formats

application/json, text/json

Sample: 
{
  "appId": 1,
  "employeeAltId": "sample String 2",
  "employerCode": "sample String 3",
  "employerId": 1,
  "message": "sample String 4",
  "personId": 1,
  "provider": 0,
  "receiverEmails": [
    "sample String 1",
    "sample String 2"
  ],
  "referenceIdentifier": "sample String 5",
  "salaryKey": "sample String 6",
  "verificationOrderId": 1,
  "verificationOrderTypeCode": "sample String 7",
  "verificationType": 0
}

text/html

Sample: 
{"appId":1,"employeeAltId":"sample String 2","employerCode":"sample String 3","employerId":1,"message":"sample String 4","personId":1,"provider":0,"receiverEmails":["sample String 1","sample String 2"],"referenceIdentifier":"sample String 5","salaryKey":"sample String 6","verificationOrderId":1,"verificationOrderTypeCode":"sample String 7","verificationType":0}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Email verification document; otherwise, RPC error.

RPCResponse
NameDescriptionTypeAdditional information
data

Gets or sets the data.

 Object

None.
errors

Gets or sets the errors.

 Collection of RPCError2

None.
included

Gets or sets the included.

 Collection of Object

None.
messages

Gets or sets the errors.

 Collection of string

None.
modelId

Gets or sets the model identifier.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "data": {},
  "errors": [
    {
      "code": "DataValidation",
      "detail": "sample String 1",
      "id": "sample String 2",
      "status": 100,
      "title": "sample String 3"
    },
    {
      "code": "DataValidation",
      "detail": "sample String 1",
      "id": "sample String 2",
      "status": 100,
      "title": "sample String 3"
    }
  ],
  "included": [
    {},
    {}
  ],
  "messages": [
    "sample String 1",
    "sample String 2"
  ],
  "modelId": 1
}

text/html

Sample: 
{"data":{},"errors":[{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"},{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"}],"included":[{},{}],"messages":["sample String 1","sample String 2"],"modelId":1}