ScoreMyCash API
Developer API Resources
CashDynamics (productId 1) Request
The request structure for CashDynamics is shown below. There are three main areas to the request: API control, applicant information, and bank transaction data. The API control portion includes which productId to use, the ability to turn on or off sending back a CashDynamics Report, and the unique subscriberId issued to you by ScoreMyCash. If the returnReport field is missing in the request the API will automatically include the report in the response. The applicantInformation contains information about the individual applying for credit. All fields are required except for dateOfBirth, routingNumber, accountNumber, employer, monthlyIncome, and ipAddress. The bankTransactionData node includes which aggregator is being used and the raw bank transaction data from the aggregator. The list of valid aggregators includes: Validifi: 1 Decision Logic: 2 Finicity: 3 Get Credit: 4 MicroBilt: 5 Ocrolus: 6 Plaid: 7 Yodlee: 8 Chirp: 9 Edge: 10 Flinks: 11 { "lenderRequest": { "productId": 1, "returnReport": (“yes”/”no”) "subscriberId": "ID issued to you by ScoreMyCash", "applicantInformation": { "firstName": "John", "lastName": "Smith", "mobilePhone": "1234567890", "email": "john.smith@emaildomain.com", "addressline2": "123 Fake Road", "city": "Fake City", "state": "MO", "zipcode": "12345", "ssn": 123456789, "dateOfBirth": "1950-01-01", "routingNumber": "000123456", "accountNumber": "000000123456789", "employer": "My Employer", "monthlyIncome": "5000", "ipAddress": "123.45.67.890", "uniqueId": "Your System Unique ID", "newOrReturning": "new" }, "bankTransactionData": { "aggregatorId": 2, "data": {"aggregator raw data goes here"} } } }
CashDynamics (productId 1) Response
The primary nodes are the smcReferenceId which is the ScoreMyCash internal reference ID for the request, the uniqueId which is the unique ID we saw when you sent in your request as the unique ID from your system, and the smcCashDynamics node. Under the smcCashDynamics node there are three subsets of information: attributes, transactions, and reportBase64Enc. The attributes node contains the various attributes from the CashDynamics credentialed bank data analytics. The transactions node are all the transactions cleaned, categorized, and tagged. The reportBase64End is the HTML CashDynamics report that has been zipped to condense it and then base64 encoded for response within the JSON. IMPORTANT: you can disable the report being returned in the response by setting the option returnReport='no' in the Request. { "smcReferenceId": "string", "requestDate": "2025-02-11T16:17:44.066Z", "unqiueId": "string", "smcCashDynamics": { "attributes": { "flags_tags": {}, "scores": {}, "identity": {}, "loanops": {}, "income": {}, "spending": {}, "overdraft": {}, "tradelines": {}, "cashdynamics": {} }, "transactions": [{ "bankName": "string", "routingNumber": "string", "accountName": "string", "accountType": "string", "accountNumber": "string", "currentBalance": 0, "availableBalance": 0, "firstName": "string", "lastName": "string", "mobilePhoneNumber": "string", "emailAddress": "string", "addressLine2": "string", "city": "string", "state": "string", "zipCode": "string", "transactionDate": "string", "transactionDebitCredit": "string", "transactionId": "string", "transactionDescription": "string", "transactionAmount": 0, "accountRunningBalance": 0, "mergedRunningBalance": 0, "returnCode": "string", "returnDate": "string", "industryCategory": "string", "industry": "string", "merchantName": "string" }], "reportBase64Enc": "string" } }
CashDynamics Error Codes
The following error codes are possible for CashDynamics: Err_1 The Data object must contain report data Err_2 Field ProductId must be a valid productId between 1 and 3 Err_3 Field applicantInformation is null Err_4 The submitted Request is null Err_5 Field ssn is required for CashDynamics requests Err_6 Valid ssn is required for CashDynamics requests Err_7 Valid ssn must be ten digits and include leading zeros where necessary Err_8 Routing Number can not be in sequence in CashDynamics requests Err_9 Valid routingNumber must be nine digits and include leading zeros where necessary Err_10 Valid accountNumber must be between four and seventeen digits and include leading zeros where necessary Err_11 Valid email is required for CashDynamics requests Err_12 Field email is required for CashDynamics requests Err_13 Valid mobilePhone is required for CashDynamics requests Err_14 Field mobilePhone is required for CashDynamics requests Err_15 Valid firstName must be two or more characters Err_16 Field firstName is required for CashDynamics requests Err_17 Valid lastName must be two or more characters Err_18 Field lastName is required for CashDynamics requests Err_19 Field addressline2 is required for CashDynamics requests Err_20 Valid city must be three of more characters Err_21 Field city is required for CashDynamics requests Err_22 Valid state must be two characters Err_23 Field state is required for CashDynamics requests Err_24 Valid zipcode must be five digits and include leading zeros where necessary Err_25 Field zipcode is required for CashDynamics requests Err_26 Valid dateOfBirth must be format yyyy-mm-dd between 1950 and today Err_27 Field dateOfBirth is required for CashDynamics requests Err_28 The submitted subscriberId is invalid Err_29 Field uniqueId is required for CashDynamics requests Err_30 Valid values for newOrReturning are either new or returning Err_31 Field newOrReturning is required for CashDynamics requests Err_32 Valid employer must be two or more characters Err_33 Valid monthlyIncome must be three or more digits Err_34 Valid ipAddress must be format digitsdigitsdigitsdigits Err_69 CashDynamics database error Err_71 Invalid aggregatorId
About This Developer Page
This developer page contains the resources you need to quickly integrate and start using ScoreMyCash solutions.
ScoreMyCash Solutions
The ScoreMyCash solutions (CashDynamics & CashVerifi) provide the features and data necessary to analyze and decision on cashflow data so you can build workflows tailored to your underwriting decisioning.
Our technology makes it easy to digest, standardize, transform, and analyze your customers' cashflow data for those that log in and for those that do not login we offer insights into their cashflow when you just have the applicant PII. The solutions enable you to make more informed decisions based on cashflow data whether or not your customer has logged-in or just provided their PII.
Using ScoreMyCash APIs
To access the ScoreMyCash APIs, you will need a bearer token and subscriber code. If you have an active account, you can acquire a bearer token from the API endpoint.
CashVerifi (productId 2) Request
The request structure for CashDynamics is shown below. There are two main areas to the request: API control and applicant information. The API control portion includes which productId to use and the unique subscriberId issued to you by ScoreMyCash. The applicantInformation contains information about the individual applying for credit. All fields are required except for employer, monthlyIncome, and ipAddress. { "lenderRequest": { "productId": 2, "subscriberId": "ID issued to you by ScoreMyCash", "applicantInformation": { "firstName": "John", "lastName": "Smith", "mobilePhone": "1234567890", "email": "john.smith@emaildomain.com", "addressline2": "123 Fake Road", "city": "Fake City", "state": "MO", "zipcode": "12345", "ssn": 123456789, "dateOfBirth": "1950-01-01", "routingNumber": "000123456", "accountNumber": "000000123456789", "employer": "My Employer", "monthlyIncome": "5000", "ipAddress": "123.45.67.890", "uniqueId": "Your System Unique ID", "newOrReturning": "new" } } }
CashVerifi (productId 2) Response
The primary nodes are the smcReferenceId which is the ScoreMyCash internal reference ID for the request, the uniqueId which is the unique ID we saw when you sent in your request as the unique ID from your system, and the smcCashVerifi node. Under the smcCashVerifi node there is one node of information: attributes. The attributes node contains the various attributes from the CashVerifi non-credentialed bank data analytics. { "smcReferenceId": "string", "requestDate": "2025-02-11T16:17:44.066Z", "unqiueId": "string", "smcCashVerify": { "cvidentity": {}, "cvloanops": {}, "cvincome": {}, "cvtradelines": {} } }
CashVerifi Error Codes
The following error codes are possible for CashVerifi: Err_2 Field ProductId must be a valid productId between 1 and 3 Err_3 Field applicantInformation is null Err_4 The submitted Request is null Err_37 Field ssn is required for CashVerifi requests Err_38 Valid ssn is required for CashVerifi requests Err_39 Valid ssn must be ten digits and include leading zeros where necessary Err_40 Routing Number can not be in sequence in CashVerifi requests Err_41 Valid routingNumber must be nine digits and include leading zeros where necessary Err_42 Valid accountNumber must be between four and seventeen digits and include leading zeros where necessary Err_43 Valid email is required for CashVerifi requests Err_44 Field email is required for CashVerifi requests Err_45 Valid mobilePhone is required for CashVerifi requests Err_46 Field mobilePhone is required for CashVerifi requests Err_47 Valid firstName must be two or more characters Err_48 Field firstName is required for CashVerifi requests Err_49 Valid lastName must be two or more characters Err_50 Field lastName is required for CashVerifi requests Err_51 Field addressline2 is required for CashVerifi requests Err_52 Valid city must be three of more characters Err_53 Field city is required for CashVerifi requests Err_54 Valid state must be two characters Err_55 Field state is required for CashVerifi requests Err_56 Valid zipcode must be five digits and include leading zeros where necessary Err_57 Field zipcode is required for CashVerifi requests Err_58 Valid dateOfBirth must be format yyyy-mm-dd between 1950 and today Err_59 Field dateOfBirth is required for CashVerifi requests Err_60 The submitted subscriberId is invalid Err_61 Field uniqueId is required for CashVerifi requests Err_62 Valid values for newOrReturning are either new or returning Err_63 Field newOrReturning is required for CashVerifi requests Err_64 Valid employer must be two or more characters Err_65 Valid monthlyIncome must be three or more digits Err_66 Valid ipAddress must be format digitsdigitsdigitsdigits Err_70 CashVerifi database error