Ingomoney’s Check Cashing SDK API Methods are secured using standard OAuth 2.0 protocols.
| Core Methods | Ancillary Methods |
|---|---|
| Authenticate Partner | AddCustomerAttributes |
| FindCustomer | AddSessionAttributes |
| EnrollCustomer | |
| GetRegisteredCards | |
| AddOrUpdateCard | |
| AddOrUpdateTokenizedCard | |
| AuthenticateOBO | |
| GetTransactionHistory | |
| DeleteCard |
The following Headers should be sent with every method request EXCEPT for
AuthenticatePartner.
| Element Name | Element Type | Required/Optional | Description |
|---|---|---|---|
| deviceId | String | Required | This should be the same value used in AuthenticatePartner. |
| sessionId | String | Required | This is the sessionId value obtained within the AuthenticatePartner method. |
This method is used to validate that the application has the right to connect to the Ingo Money servers. This call should precede any other calls to the Ingo Money server. Upon success, you will receive a sessionId value that will be required within all other method calls.
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/authenticate
Sample Response Header
sessionId: Mzc2ODk2ZDYtNmVhOC00NDJmLWJiNWEtMThiMWRiYTAzM2RjOjEyNjozNzY4OTZkNi02ZWE4LTQ0MmYtYmI1YS0xOGIxZGJhMDMzZGD=
Sample Error Response:
{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "Authorization has been denied for this request.",
"instance": "/api/v1/partners/authenticate",
"errorCode": "UNAUTHORIZED"
}
This method is used to find a customer in the system. If the customer is not found, then CustomerId will be an empty string.
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/find-customer
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| ssn | String | Required | 9 | 9 | 9 digit social security number, or ITIN, for the customer. No formatting is supported. Must be in the form of 123456789. |
| dateOfBirth | String | Required | 10 | 10 | The customer’s date of birth. Acceptable formats include MM/DD/YY, MM-DD-YY, YYYY/MM/DD, or YYYY-MM-DD. |
Sample Request:
{
"ssn" : "123456789",
"dateOfBirth" : "05/31/1988"
}
Sample Response:
{
"customerId": "5cd26e67-66b1-4f12-b9f4-963ce27a03ac"
}
Sample Error Response:
{
"type": "https://tools.ietf.org/html/rfc4918#section-11.2",
"title": "Customer Not Found",
"status": 422,
"detail": "We're sorry, this customer was not found. Please check SSN and DOB and try again. (A172)",
"instance": "/api/v1/partners/find-customer",
"errorCode": "CUSTOMER_NOT_FOUND"
}
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/enroll-customer
This method is used to enroll a new customer. Before enrolling the customer, this method will check to see if either the SSN and/or email address are currently in use in the system. If the user data already exists, a corresponding ErrorCode and ErrorMessage are returned.
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| emailAddress | String | Required | 1 | 100 | Email address of the customer. Must be a valid email address and contain an @ sign. |
| ssn | String | Required | 1 | 9 | Social Security number, or ITIN, of the user. Must be a 9 digit string, no spaces, no dashes. |
| firstName | String | Required | 1 | 50 | First name of the person being added. |
| lastName | String | Required | 1 | 50 | Last name of the person being added. Max length is 50 characters. |
| middleInitial | String | Optional | 1 | 1 | Single character middle initial. |
| title | String | Optional | 0 | 10 | Title of the individual being added. Typically would contain one of Mrs, Mr, etc. |
| suffix | String | Optional | 0 | 10 | Suffix of the individual being added. Typically would contain one of Jr, Sr, etc. |
| mobileNumber | String | Required | --- | 10 | The 10-digit mobile number of the user. When present must be exactly 10 digits and contain no formatting characters. |
| homeNumber | String | Optional | --- | 10 | The 10-digit home number of the user. Must be exactly 10 digits and contain no formatting characters. |
| addressLine1 | String | Required | 1 | 50 | The first line of the customer’s address. |
| addressLine2 | String | Required | 1 | 50 | The second line of the customer’s address. |
| city | String | Required | 1 | 50 | The corresponding city of the customer’s address. |
| state | String | Required | 1 | 2 | Abbreviated state code. The corresponding state of the customer’s address. |
| zip | String | Required | 5 | 5 | The corresponding zip of the customer’s address. 5-digit zip only. |
| dateOfBirth | String | Required | 10 | 10 | The customer’s date of birth. Acceptable formats include MM/DD/YY, MM-DD-YY, YYYY/MM/DD, or YYYY-MM-DD. |
| countryOfOrigin | String | Optional | 0 | --- | The user’s country of origin for optional OFAC checking. |
| gender | String | Optional | 0 | 1 | Single character string indicating M/F. |
| allowTexts | String | Required | 1 | 1 | Indicates if the user is willing to accept text messages. The system does not currently communicate via text at this time. |
| referrerCode | String | Optional | 0 | 50 | Customer enrollment referral code |
Sample Request:
{
"email": "5QY8A9Pr7b@gmail.com",
"ssn": "684832266",
"firstName": "Roger",
"lastName": "Rabbit",
"middleInitial": "R",
"title": "Mr.",
"suffix": "",
"mobileNumber": "6153456789",
"homeNumber": "6153456565",
"addressLine1": "660 Bakers Bridge Lane",
"addressLine2": "Suite 100 ",
"city ": "Franklin",
"state ": "TN ",
"zip ": "37067 ",
"dateOfBirth ": "1978-09-11",
"allowTexts": true
}
Sample Response:
{
"CustomerId": "333554bf-b273-4d6e-b4f8-d319a1929608"
}
Sample Error Response:
{
"errors": {},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"instance": "/api/v1/partners/enroll-customer",
"validationErrors": [
{
"key": "command.Gender",
"message": "Gender cannot exceed 1 character"
}
]
}
This method is used to authenticate a specific customer. If authentication is successful, a one-time use ssoToken is returned.
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/authenticate-obo
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| customerId | Guid | Required | 36 | 36 | The Ingo assigned customer ID associated with the customer. |
Sample Request:
{
"customerId": "333554bf-b273-4d6e-b4f8-d319a1929608"
}
Sample Response:
{
"ssoToken": "NjI4NWRlNzYtOTYxNC00Y2MyLWE3MjctMGYyN2E2NTRhZmQxOmI4M2E3NWQzLWU0MDYtNGMyYi04ZjA1LWU3YzlhNDcwMzNhBQ=="
}
Sample Error Responses:
{
"type": "https://tools.ietf.org/html/rfc4918#section-11.2",
"title": "Customer Not Found",
"status": 422,
"detail": "Oops, your customer information does not exist in our service. Please check your login and try again. (A45)",
"instance": "/api/v1/partners/authenticate-obo",
"errorCode": "CUSTOMER_NOT_FOUND"
}
{
"type": "https://tools.ietf.org/html/rfc4918#section-11.2",
"title": "No linked account",
"status": 422,
"detail": "The customer does not have a linked account.",
"instance": "/api/v1/partners/authenticate-obo",
"errorCode": "NO_LINKED_ACCOUNT"
}
Returns a list of registered cards to the user. No pertinent PAN information is returned as part of this call.
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/get-registered-cards
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| customerId | Guid | Required | 36 | 36 | The Ingo assigned customer ID of the cards to be retrieved |
Sample Request:
{
"customerId": "4g623rb9-48gh-7594-a5d6-268d37362d65"
}
Sample Response:
{
"cards": [{
"cardArtAsBase64Png": "",
"cardId": "07ae09f7-8b55-4f4e-8f3beb5aadf6e398",
"cardNickname": "Nickname 2749",
"cardProgram": "Super Duper Card",
"customerId": "5f73fb4e-3e5a-428c-95cf-e4c6e4cbae14",
"lastFourDigits ": "2749 ",
"showTermsAndConditions": true,
"termsAndConditionsId": "TC1.1",
"issuerType": 1,
"expirationMonthYear": "1129",
"cardProgramPhone": "5554445565",
"currentCardMin": 500,
"currentCardMax": 50000
}]
}
Sample Error Response:
{
"errors": {},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"instance": "/api/v1/partners/get-registered-cards",
"validationErrors": [
{
"key": "query.customerId",
"message": "The input was not valid."
}
]
}
This method is used to add or update a card within the system. This allows partners to make changes to cards without keeping track of which updates have been sent to Ingo. Partners may only update their own cards.
If the passed card data exactly matches the information in the Ingo system, no changes will be made, and the card won’t be reauthorized (AVS check, etc.). If any of the card data changes (e.g., expiration, etc.), the card will be reauthorized. An authorization failure will cause that card to be flagged as invalid in the system. In this case, a corresponding ErrorCode
and ErrorMessage are returned.
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/add-or-update-card
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| customerId | Guid | Required | 36 | 36 | Customer whose card is being added or updated. |
| cardNumber | String | Required | 15 | 19 | Unformatted 15 or 16 digit card PAN. |
| expirationMonthYear | String | Required | 4 | 4 | Unformatted month/year of the card. Should always be four digits. Months that are single digits should be preceded by a 0. For example, May 2015 would be represented as 0515. |
| cardNickname | String | Required | 1 | 20 | Nickname the user would like for the card. Something like “My Allowance”. Max Length is 20 characters. |
| nameOnCard | String | Optional | 0 | 100 | The name of the user found on the front of the card. |
| addressLine1 | String | Required | 1 | 50 | The first line of the customer’s address. Max length is 100 characters |
| addressLine2 | String | Required | 1 | 50 | The second line of the customer’s address. Max length is 100 characters. |
| city | String | Required | 1 | 50 | The city of the user. Max length is 50 |
| state | String | Required | 1 | 2 | The state of the user. Max length is 2 |
| zip | String | Required | 5 | 5 | The zip code of the user. 5-digit zip is all that is required. |
Sample Request:
{
"customerId": "333554bf-b273-4d6e-b4f8-d319a1929608",
"cardNumber": "4111111504856777",
"expirationMonthYear": "1225",
"cardNickname": "Home",
"nameOnCard": "Test User",
"addressLine1": "123 Main Street",
"addressLine2": "",
"city": "Nashville",
"state": "TN",
"zip": "37075"
}
Sample Response:
{
"cards": [
{
"cardId": "1db0c5a1-62fc-4295-8a12-7997056d4fc9",
"lastFourDigits": "6777",
"customerId": "",
"showTermsAndConditions": false,
"termsAndConditionsId": "",
"cardArtAsBase64Png": "",
"cardProgram": "",
"cardNickname": "",
"expirationMonthYear": "",
"cardProgramPhone": "",
"currentCardMax": 0,
"currentCardMin": 0,
"issuerType": 0,
"hashId": ""
}
]
}
Sample Error Response:
{
"errors": {},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"instance": "/api/v1/partners/add-or-update-card",
"validationErrors": [
{
"key": "command.CardNumber",
"message": "CardNumber cannot exceed 19 characters"
}
]
}
Adds or updates an existing card within the system utilizing a alphanumeric value in place of sending the actual card PAN. This allows partners to make changes to cards without keeping track of which updates have been sent to Ingo. Partners may only update their own cards.
If the data is not modified, no changes are done, and the card won’t be validated. If the card number or expiration changes, the card will be reauthorized. A failure in authorization will mark that card as invalid in the system. This information is returned in the ErrorCode and ErrorMessage. Validation is only done if an appropriate validator is setup for the card program, which is on a card-by-card basis. Some partners may choose to not do validation.
In order to utilize the AddOrUpdateTokenized API method, it is required that Ingo has a direct method of sending load requests with your servers. This is due to only you knowing the actual card numbers being linked to the Tokenized placeholder value, which allows us not to use the normal OCT loading scenarios.
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/add-or-update-tokenized-card
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| customerId | Guid | Required | 36 | 36 | Customer whose card is being added or updated. |
| cardToken | String | Required | 0 | 255 | Up to 256 character long encoded card token. |
| cardBin | String | Required | 1 | 50 | 6 to 8-digit bin number for card to be registered. |
| lastFourOfCard | String | Optional | 0 | 4 | Last 4 of unformatted 15 or 16 digit card PAN. |
| expirationMonthYear | String | Required | 4 | 4 | Unformatted month/year of the card. Should always be four digits. Months that are single digits should be preceded by a 0. For example, May 2015 would be represented as 0515. |
| cardNickname | String | Required | 1 | 20 | Nickname the user would like for the card. Something like “My Allowance”. Max Length is 20 characters. |
| nameOnCard | String | Optional | 0 | 100 | The name of the user found on the front of the card. |
| addressLine1 | String | Required | 1 | 50 | The first line of the customer’s address. Max length is 100 characters |
| addressLine2 | String | Required | 1 | 50 | The second line of the customer’s address. Max length is 100 characters. |
| city | String | Required | 1 | 50 | The city of the user. Max length is 50 |
| state | String | Required | 1 | 2 | The state of the user. Max length is 2 |
| zip | String | Required | 5 | 5 | The zip code of the user. 5-digit zip is all that is required. |
Sample Request:
{
"customerId": "333554bf-b273-4d6e-b4f8-d319a1929608",
"cardToken": "42f76930-2662-4839-bf9f-8bfbe9b58cca",
"cardBin": "12345 ",
"expirationMonthYear": "1225",
"cardNickname": "Home",
"nameOnCard": "Roger Rabbit",
"addressLine1": "123 Main St.",
"addressLine2": "",
"city": "Nashville",
"state": "TN",
"zip": "37075"
}
Sample Response:
{
"cards": [{
"cardId": " 3b2ef6d2-76f2-43bb-b9ab-dc5be2c5c3db",
"cardNickname": "",
"cardProgram": "",
"customerId": "333554bf-b273-4d6e-b4f8-d319a1929608",
"lastFourDigits": "****",
"hashId": ""
}]
}
Sample Error Response:
{
"type": "https://tools.ietf.org/html/rfc4918#section-11.2",
"title": "Error",
"status": 422,
"detail": "Sorry, the account you're attempting to register is not allowed in our network.(A275)",
"instance": "/api/v1/partners/add-or-update-tokenized-card",
"errorCode": "BAD_REQUEST"
}
This method is used to get a customer’s transaction history. It has optional support for paging of data.
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/get-transaction-history
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| customerId | Guid | Required | 36 | 36 | The Ingo assigned customer ID that is requesting to use the Ingo Service. |
| accountId | Guid | Optional | 36 | 36 | The Ingo cardId GUID assigned when the card was registered. If you wish to get the transactional history for a specific card, this is the field you would specify that card. |
| pagingTransactionReferenceNumber | Guid | Optional | 36 | 36 | GUID representing the first transaction in a page to return. This transaction and the next pageSize transactions older than it will be returned. |
| pageSize | Int | Optional | 0 | 10 | Integer representing how many transactions to return per page. By default, the 20 most recent will be returned. |
Sample Request:
{
"customerId": "2eaf7fe8-8d9c-414c-9763-9a7e897d8496",
"accountId": "",
"pagingTransactionReferenceNumber": "",
"pageSize": 3
}
Sample Response:
{
"searchResults": [{
"statusCode": 14,
"statusMessage": "Account Funded",
"state": 4,
"transactionId": "a00b79cc-64c5-42ae-a1bf-b93ba04cbd8f",
"createdOn": "2023-07-12T13:07:04Z",
"amount": 1173,
"fee": 59,
"processingStatus": 1101,
"classificationStatus": 1012,
"declineReasonCode": 0,
"declineReasonMessage": "",
"pickupLocationId": 0,
"mobileTransactionTypeId": 100,
"ocrAmount": 1173,
"userEnteredAmount": 1173,
"submittedForClassificationOn": "2023-07-12T13:07:04Z",
"finishedClassificationOn": "2023-07-12T13:07:04Z",
"submittedForApprovalOn": "2023-07-12T13:07:11Z",
"finishedApprovalOn": "2023-07-12T13:07:14Z",
"lastFourDigitsOfCard": "",
"cardNickname": "",
"loadStatus": 1011,
"expectedLoadDate": "2023-07-12T13:07:11Z",
"actualLoadDate": "2023-07-12T13:07:14Z",
"loadAmount": 1114,
"destinationDisplayName": "John Smith"
}],
"totalRecords": 6
}
Sample Error Response:
{
"errors": {},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"instance": "/api/v1/partners/get-transaction-history",
"validationErrors": [
{
"key": "query.customerId",
"message": "The input was not valid."
}
]
}
Delete a given card. Note, the card can be added back, but will result in a different card entry in the database.
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/delete-card
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| customerId | Guid | Required | 36 | 36 | The Ingo assigned customer ID associated with the card you wish to delete. |
| cardId | Guid | Required | 36 | 36 | The Ingo assigned card ID of the card you wish to delete. |
Sample Request:
{
"customerId": "333554bf-b273-4d6e-b4f8-d319a1929608",
"cardId": "3b242db9-67fc-4087-b0d6-156d37362a13"
}
Sample Response:
Sample Error Response:
{
"errors": {},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"instance": "/api/v1/partners/delete-card",
"validationErrors": [
{
"key": "command.cardId",
"message": "The input was not valid."
}
]
}
This method passes Ingo Money Predictive Data for our partners to enhance the Ingo user experience and accelerate risk
decisioning for high value cardholders within your implementation. This predictive data is utilized to:
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/add-customer-attributes
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| customerAttributes | Array | Required | --- | --- | An array of Customer Attribute objects. |
| name | String | Required | 1 | 100 | Defined customer attribute name |
| value | String | Required | 1 | 200 | Customer attribute value |
| CUSTOMER ATTRIBUTE NAME | RQMT | VALUE DESCRIPTION |
|---|---|---|
| CustomerId | Required | The Ingo Money GUID assigned to the customer upon enrollment |
| SSN | Required | Social Security number, or ITIN, of the user. Must be a 9 digit string, no spaces, no dashes. |
| NumberOfCards | Optional | Numeric number of cards the customer has registered |
| Tenure | Optional | Length of time the customer has the registered card. If there are multiple cards, please provide the longest tenured card. Value should be expressed in number of months |
| DirectDeposit | Optional | Boolean Identifies if the customer is currently enrolled for direct deposit. Value should be True or False. |
| CurrentBalance | Optional | Current card balance. If multiple cards are registered, please provide an average. (Format DDDDD.CC) |
| AverageMonthlyLoadAmount | Optional | Average monthly amount loaded via any means (cash/ACH/Direct Deposit). If multiple cards are registered, please provide an average. (Format DDDDD.CC) |
| TransactionsPerMonth | Optional | Numeric number of transactions per month. If multiple cards are registered, please provide an average. |
| CardIssueDate | Optional | Date card was issued. Format is MM-DD-YYYY |
| NumberOfChecksCashed | Optional | Numeric number of check cashed within the last 90 days |
| NumberOfChecksReturned | Optional | Numeric number of checks returned within the last 90 days |
| BalanceOnReturnedChecks | Optional | Total outstanding debt balance on all returned checks. Format is DDDDD.CC |
| AverageCheckCashedAmt | Optional | The average amount of cashed checks within the last 90 days. Format should be DDDDD.CC |
| DebitActive | Optional | Boolean denotes whether Debit capabilities are enabled. Values are True of False |
| LastDebitPurchaseDate | Optional | Date that debit support was activated. Format is MM-DD-YYYY |
| TotalNumberOfCustomers | Optional | Numeric total number of active customers. |
Sample Request:
{
"customerAttributes": [{
"name": "CustomerId",
"value": "87e59d88-c15c-4513-87d0-6bdb49c4b29e"
},
{
"name": "SSN",
"value": "111224444"
}, {
"name": "DirectDeposit",
"value": "True"
}, {
"name": "Tenure",
"value": "18"
},
{
"name": "TransactionsPerMonth",
"value": "4"
}, {
"name": "NumberOfCards",
"value": "2"
},
{
"name": "CurrentBalance",
"value": "3456.76"
}, {
"name": "AverageMonthlyLoadAmount",
"value": "6114.25"
}
]
}
Sample Response:
Sample Error Response:
{
"errors": {},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"detail": "One or more validation errors occurred.",
"instance": "/api/v1/partners/add-customer-attributes",
"validationErrors": [
{
"key": "command.CustomerAttributes[7].Value",
"message": "The Value field is required."
}
]
}
This method allows a single email to be associated with multiple registered PANs or card number representatives. It also sets which cards are available to the user within the application. Additional attributes may be added in the future that can be used to modify processing behavior. This may be called only after you receive an SSO Token using the AuthenticateOBO method.
NOTE: This is a temporary change and will only last as long as the session does. If customer information needs to be changed permanently, they must contact Ingo Money Customer Service and request the information change.
Request URL: https://check-cashing-uat.spykemobile.net/api/v1/partners/add-session-attributes
Parameters
| PARAMETER | TYPE | RQMT | MIN_LEN | MAX_LEN | DESCRIPTION |
|---|---|---|---|---|---|
| sessionAttributes | Array | Required | --- | --- | An array of Session Attribute objects. |
| name | String | Required | 1 | 100 | Defined session attribute name |
| value | String | Required | 1 | 300 | Session attribute value |
| SESSION ATTRIBUTE NAME | RQMT | DESCRIPTION |
|---|---|---|
| SsoToken | Required | Customer authentication token returned from a successful AuthenticateOBO call |
| Preferred Email | Optional | Email address for customer communicaiton |
| AccountIdFilter | Optional* | Comma separated list of Ingo Card identifiers (GUID) that you wish to see in this app. If no value is set, then you will see All cards available to that user |
| AccountNumberFilter | Optional* | Comma separated list of raw card numbers that you wish to see in this app. If no value is set, then you will see All cards available to that user. This does support card tokens as well (the ones that are used on AddOrUpdateTokenizedCard) |
Note the AccountIdFilter and AccountNumberFilter attributes are mutually exclusive. If they are both passed in the request, an error will be returned. We will validate the account information passed for valid format and applicability to you, the client, or the customer. If the validation fails, you will receive a non-zero ErrorCode in the response.
Sample Request:
{
"sessionAttributes": [{
"name": "SsoToken",
"value": "ABC123"
}, {
"name": "PreferredEmail",
"value": "customer@domain.com "
},
{
"name ": "AccountIdFilter ",
"value ": "12345,43412,67894 "
}
]
}
Sample Response
Sample Error Response
{
"type": "https://tools.ietf.org/html/rfc4918#section-11.2",
"title": "Invalid Information",
"status": 422,
"detail": "Oops, there was a problem with your request. The following field(s) are invalid : PreferredEmail. Please check the values on the screen and try again.",
"instance": "/api/v1/partners/add-session-attributes",
"errorCode": "INVALID_INFORMATION"
}