Search
K
Policy Transactions

Errors

object
errorCodestring

This is the error code generated by BPM system

Example:INVALID_REQUEST

attributestring
errorstring

This is the error generated by BPM system

resolutionstring

Resolution generated by BPM system to resolve the error

Example
{
  "errorCode": "INVALID_REQUEST",
  "attribute": "attribute",
  "error": "error",
  "resolution": "resolution"
}

Error

object
errorCodestring

This is the NIGO id generated by BPM system

Example:BPM.NM.002

attributestring
errorstring

This is the error generated by BPM system

resolutionstring

Resolution generated by BPM system to resolve the error

Example
{
  "errorCode": "BPM.NM.002",
  "attribute": "attribute",
  "error": "error",
  "resolution": "resolution"
}

EmailChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

emailobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA00000022023

deleteRequestboolean

Flag for delete or update request. If flag==true then Delete Request else Update Request

Default:false

Example
{
  "correlationId": "657b717b7dcf554abf9ef067",
  "effectiveDate": "effectiveDate",
  "email": {
    "startDate": "startDate",
    "endDate": "endDate",
    "emailType": "PERSONAL",
    "emailAddress": "will.smith@gmail.com"
  },
  "caseId": "CA00000022023",
  "deleteRequest": false
}

PhoneChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

phoneobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

deleteRequestboolean

Flag for delete or update request. If flag==true then Delete Request else Update Request

Default:false

Example
{
  "correlationId": "657b717b7dcf554abf9ef067",
  "effectiveDate": "effectiveDate",
  "phone": {
    "startDate": "startDate",
    "endDate": "endDate",
    "phoneType": "MOBILE",
    "countryCode": "011",
    "areaCode": "973",
    "dialNumber": "765789",
    "extension": "null",
    "bestTime": "null",
    "timezone": "null"
  },
  "caseId": "CA0000007389",
  "deleteRequest": false
}

BankAccountChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

bankAccountobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

deleteRequestboolean

Flag for delete or update request. If flag==true then Delete Request else Update Request

Default:false

Example
{
  "correlationId": "657b717b7dcf554abf9ef067",
  "effectiveDate": "effectiveDate",
  "bankAccount": {
    "startDate": "startDate",
    "endDate": "endDate",
    "nameOnAccount": "abcdqwe",
    "accountStatus": "ACTIVEBANKACCOUNT",
    "accountType": "CHECKING",
    "accountNumber": "34567777745678",
    "routingNumber": "Routing_Number",
    "internationalBankAccountNumber": "ibaNumber_66",
    "branchName": "branch_66",
    "branchPhoneNumber": "7766667777",
    "branchAddress": {
      "addressType": "RESIDENCE",
      "addressLine1": "1112 Pickle Street",
      "addressLine2": "South Jersey",
      "addressLine3": "1234 Post box",
      "city": "Houston",
      "state": "TX",
      "zipCode": "66636",
      "zipCodeExtension": "1232",
      "country": "US"
    }
  },
  "caseId": "CA0000007389",
  "deleteRequest": false
}