A message for our valued customers and partners: This site is retiring, including accounts and API keys, as we migrate to the new developer portal. If you use existing API keys you will be contacted with further migration instructions. Accounts and API keys are not shared between this developer portal and the new developer portal. We recommend you review the new portal's Get Started guide for details on registering a new developer account and requesting new API keys.

Set Admin Credentials...
Get Caller Validation

get

Get Caller Validation

Updates Caller Validation with content in the body

Resource URL

https://ke6vq3ybzl.execute-api.us-east-1.amazonaws.com /getssdetails

Query Parameters

Name Description
PhoneNumber
(required)

the phone number to look up
CallerId

the ANI/Caller ID number of the incoming call
EduId

if the call is going to be transferred to the Lex bots, include the EduId of the current calls info, so Lex can reference it
SelfServiceType
(required)

the granular intent from the IVR call, Use SSMAKEAPAYMENT to ensure the lookup will retrieve the the full details
FullResults

true if you want the full json payload of details returned , false if you want the simple text summary of how many accounts, mcids etc. have been found

Request Body

Definitions

Name Type Description

Responses

Code Examples

Resource Summary

Security

Content Type

application/json

Category

Caller Validation

Schema:

HTTP Code Description

400

Bad Request

500

Internal Server Error

Working...