Passcode Lookup
This documentation will describe the Passcode Lookup (XMPSSVAC) endpoint. This endpoint is responsible for displaying all currently valid passcodes assigned to the specified account.
See the Authentication documentation for information on how to obtain the authentication headers within the request.
Use cases
- View which passcodes are valid for an account.
- View contact Default List Numbers.
Lookup passcodes
View valid passcodes for subscriber accounts.
Supported attributes
| Attribute | Type | Required | Description |
|---|---|---|---|
| *setMethod | string | Yes | Determines the endpoint you are calling. Must be XMPSSVAC to lookup passcodes. |
| ACCOUNT_NUMBER | string | Yes | The subscriber account number (9 character max). |
Example Request
curl --location "https://example.securemcloud.com/rest/rest.php?dataSource=methods&*view=xmsubmit" \
--header 'X-DICE-APPKEY: {{X-DICE-APPKEY}}' \
--header 'X-DICE-USERNAME: {{X-DICE-USERNAME}}' \
--header 'X-DICE-DATE: {{X-DICE-DATE}}' \
--header 'X-DICE-NONCE: {{X-DICE-NONCE}}' \
--header 'X-DICE-DIGEST: {{X-DICE-DIGEST}}' \
--header 'Accept: application/json' \
--form '*setMethod="XMPSSVAC"' \
--form 'ACCOUNT_NUMBER="TEST01"'
Example Response
{
"ACCOUNTS": [
{
"ACCOUNT_NUMBER": "TEST01",
"CONTACT_TYPE": "A",
"DEFAULT_LIST_NO": "08",
"PERSONAL_INFO": "Operator",
"CONTACT_NAME": "James Panelo ",
"PASSCODE": "654321 ",
"COMPANY_NAME": "DOCUMENTATION TEST ACCOUNT ",
"PHONE": " (555) 123-7894"
},
{
"ACCOUNT_NUMBER": "DLRKATE01",
"CONTACT_TYPE": "D",
"DEFAULT_LIST_NO": "10",
"PERSONAL_INFO": "Operator",
"CONTACT_NAME": "Karen Smith ",
"PASSCODE": "000111 ",
"COMPANY_NAME": "DOCUMENTATION TEST DEALER ",
"PHONE": " (555) 123-4561"
},
{
"ACCOUNT_NUMBER": "DLRKATE01",
"CONTACT_TYPE": "D",
"DEFAULT_LIST_NO": "11",
"PERSONAL_INFO": "Operator",
"CONTACT_NAME": "John Smith ",
"PASSCODE": "1111222 ",
"COMPANY_NAME": "DOCUMENTATION TEST DEALER ",
"PHONE": " (555) 123-4567"
}
],
"RESULT": "SUCCESS"
Response fields
| Field | Definition |
|---|---|
| ACCOUNT_NUMBER | Displays the account the contact is assigned to. |
| CONTACT_TYPE | Displays the contact’s assigned type. A: Account G: Global D: Dealer |
| DEFAULT_LIST_NO | Displays the identifier assigned to the contact upon creation. |
| PERSONAL_INFO | Displays any miscellaneous information assigned to the contact |
| CONTACT_NAME | Displays the contact’s first and last name. |
| PASSCODE | Displays the contact’s personal verification code used to confirm their identity. |
| COMPANY_NAME | Displays the name assigned to the subscriber account. |
| PHONE | Displays the phone number used to call the contact. |
Possible error messages
No Passcodes
Verify the account number is valid.
{
"RESULT": "There are no passcodes on this account."
}
Invalid Method
Verify you are specifying XMPSSVAC as the method.
{
"ERROR_CODE": "999",
"ERROR_DESCRIPTION": "INVALID%20METHOD%20METHOD",
"PROGRAM_ERROR": "11",
"PROGRAM_ERROR_DESCRIPTION": "Missing%20or%20Duplicate%20key",
"ERROR_ON_LINE": "240",
"ADDITIONAL_INFO": "%3CMETHOD_NAME%3Eghgh%20%20%20%20%3C%2FMETHOD_NAME%3E"
}