# Introduction Integrating with Numaly's API is simple and straightforward. For the quickest integration follow the two step workflow below. ## 1. Start Verification Request There two ways to start a verification request for an applicant * For an imbedded experience, create a new verification via the API with `send_to_applicant` field set to false. Add the returned `verification_url` to your Numaly widget below. This creates an interactive popup when clicked, allowing your users to complete a verification without leaving your application. You may also simply just use your unique link in place of the verification\_url to avoid calling the API . See a demo integration here ``` ``` * Alternatively you can trigger a verification request to be sent to an applicants via email/sms by creating a verification via the API with the `send_to_applicant` set to true. *To customize the verification experience go to* [*https://www.numaly.com/integrations*](https://www.numaly.com/integrations) ## 2. Retrieve Report Use the id returned from the first step to track the status, retrieve the report data and a link to a pdf file of the report. # Getting Started Numaly's endpoints follow the RESTful principles. To send and retrieve verifications you must pass the following http headers including your API key in every request. | Header | Value | | ----------------- | --------------------- | | **Content-Type** | application/json | | **Authorization** | Token \ | ## Environments Numaly provides two API environments, Production and Sandbox. The sandbox environment can be used to send/retrieve verification requests/reports using dummy bank data free of charge. ``` https://api.sandbox.numaly.com/v1 ``` {% hint style="warning" %} **Note**: Only email verification requests are sent when using in the sandbox. Txt message can only be used in production. {% endhint %} Once you've tested your integration you can make it live using the production endpoint. ```bash https://api.numaly.com/v1 ``` ### Test Bank Account To test your integration you may send and complete verifications using the following dummy bank free of charge. #### For testing in United States, Canada & United Kingdom use ***Bank**:* Tartan Bank ***Username**: user\_good **Password**: pass\_good* #### For testing in Australia/New Zealand use ***Comming soon*** {% hint style="info" %} Please contact us to have your API access enabled before making requests. {% endhint %} {% hint style="info" %} Please be weary all endpoints are throttled to 5 requests per second. {% endhint %} # Create Verification Request Generate verification links for applicants and send them to their email/mobile phone. ## Create Verification Request `POST` `https://api.numaly.com/v1/requests` #### Request Body | Name | Type | Required | Description | | ------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | first\_name | string | true | Applicants first name | | last\_name | string | true | Applicants last name | | email | string | true | Applicants email address | | phone\_number | String | false |

Applicants phone number to send the verification request to.
Although optional phone numbers almost guarantee a faster response.

| | reference | string | true | Reference for your record keeping (e.g property address etc) | | applicant\_pays | boolean | true | Do you want the applicant to pay the screening charge. if `false` your screening credits will be used. | | property\_rent | integer | true | Rent amount of the property applicant is applying for. Used to calculate the income to rent multiple. | | verify\_income | boolean | true | Do you want to verify applicants income via the bank | | verify\_identity | boolean | true | Do you want the appllicants identity to be verified as part of the income verification | | verify\_employment | boolean | true | Do you want to verify applicants employment via payroll account | | send\_to\_applicant | boolean | true | True if you want the verification to be sent to the applicant. If ommited this defaults to True | {% tabs %} {% tab title="201 Request successfully sent. Note: This response does not guarantee the request reached the applicants mailbox. Make sure the applicants information is accurate prior." %} ``` { "id": "4ab1e5530-fb76-4621-b11a-c4480708fb2f", "verification_url": "https://example.numaly.com/request/1af90f9f-8640-4a53-8dbc-5a8f593a32a0" "expiry_date": "2021-03-10" } ``` {% endtab %} {% tab title="400 Invalid phone number (440)" %} ``` ``` {% endtab %} {% tab title="402 Insufficient screening credits." %} ``` ``` {% endtab %} {% endtabs %} # Resend Verification Request Resend a verification request ## Resend Verification Request `POST` `https://api.numaly.com/v1/requests/{id}/resend` **Note:** You may also only resend a request a maximum of 5 times. #### Path Parameters | Name | Type | Required | Description | | ---- | ------ | -------- | ---------------------------------------------- | | id | string | true | Verification request `id` or your `request_id` | {% tabs %} {% tab title="201 Request resent successfully." %} ``` ``` {% endtab %} {% tab title="403 Resend limit exceeded (maximum of 5)" %} ``` ``` {% endtab %} {% tab title="404 Verification request not found." %} ``` ``` {% endtab %} {% endtabs %} # List all Verification Requests List all verifications requests ## List verification requests `GET` #### Query Parameters | Name | Type | Required | Description | | ---- | ------ | -------- | --------------------------------------------------------------------------------------------- | | ids | String | false | Either an id or your request id. To pass multiple values send it as a comma separated string. | **Response** {% tabs %} {% tab title="200" %} 

{
    "links": {
        "next": null,
        "previous": null
    },
    "page_size": 10,
    "count": 3,
    "ts": 1735894196.943309,
    "results": [
        {
            "id": "7bb5a672-acf1-4186-9167-e0085b38e268",
            "send_to_applicant": true,
            "report_url": "https://www.numaly.com/request/...",
            "identity_report_url": "https://www.numaly.com/request/...",
            "paystub_url": "https://www.numaly.com/request/...",
            "request_id": null,
            "request_date": "2022-01-20",
            "response_date": "2022-01-20",
            "from_date": "2021-01-20",
            "to_date": "2022-01-20",
            "days_retrieved": 365,
            "months_retrieved": 12,
            "requester_name": "ABC Realtor",
            "first_name": "Sarah",
            "last_name": "Sample",
            "currency": "USD",
            "status": "awaiting screening",
            "reference": "10 Sample Rd",
            "property_rent": null,
            "email": "sarahsample@numaly.com",
            "phone_number": null,
            "identity_accept_tos_status": true
            "identity_verify_sms_status": true
            "identity_kyc_check_status": true
            "identity_document_verification_status": true
            "identity_selfie_check_status": true
            "identity_watchlist_screening_status": true
            "identity_risk_status": true
            "permitted_verification_method": ['all']
            "allow_paystub_upload": true
            "verify_identity": true
            "employer": "ABC Hospital",
            "total_income": "99538.80",
            "income_projection_12_months": null,
            "average_monthly_income": "8294.88",
            "average_monthly_income_last_3": "7900.47",
            "total_recurring_income": "97968.00",
            "average_monthly_income_recurring": "8123.60",
            "total_non_recurring_income": "1570.80",
            "average_monthly_income_non_recurring": "171.27",
            "total_deposits": 108,
            "total_recurring_deposits": 104,
            "total_non_recurring_deposits": 4,
            "income_rent_multiple": 15.0,
            "expense_income_ratio": 0.22,
            "average_monthly_expenses": "1857.54",
            "average_days_between_rent_payments": null,
            "applicant_note": "",
            "account_names": "Sarah Samples",
            "sources": [
                {
                    "name": "Abc Hospital",
                    "amount": 71684.86,
                    "recurring": 71684.86,
                    "non_recurring": 0,
                    "total_deposits": 98,
                    "last_10_deposits": [
                        {
                            "date": "2021-03-16",
                            "amount": 530.93,
                            "source": "Abc Hospital"
                        },
                        {
                            "date": "2021-03-16",
                            "amount": 530.93,
                            "source": "Abc Hospital"
                        },
                        {
                            "date": "2021-03-12",
                            "amount": 1240.93,
                            "source": "Abc Hospital"
                        },
                        {
                            "date": "2021-03-12",
                            "amount": 153.94,
                            "source": "Abc Hospital"
                        },
                        {
                            "date": "2021-03-12",
                            "amount": 1240.93,
                            "source": "Abc Hospital"
                        },
                        {
                            "date": "2021-03-12",
                            "amount": 153.94,
                            "source": "Abc Hospital"
                        },
                        {
                            "date": "2021-03-10",
                            "amount": 336.15,
                            "source": "Abc Hospital"
                        },
                        {
                            "date": "2021-03-10",
                            "amount": 540.35,
                            "source": "Abc Hospital"
                        },
                        {
                            "date": "2021-03-10",
                            "amount": 336.15,
                            "source": "Abc Hospital"
                        },
                        {
                            "date": "2021-03-10",
                            "amount": 540.35,
                            "source": "Abc Hospital"
                        }
                    ]
                },
                {
                    "name": "ANZ Investments",
                    "amount": "392.7.8",
                    "recurring": 0,
                    "non_recurring": 1570.8,
                    "total_deposits": 4,
                    "last_10_deposits": [
                        {
                            "date": "2021-02-13",
                            "amount": 392.7,
                            "source": "ANZ Investments"
                        },
                        {
                            "date": "2021-02-13",
                            "amount": 392.7,
                            "source": "ANZ Investments"
                        },
                        {
                            "date": "2020-12-25",
                            "amount": 392.7,
                            "source": "ANZ Investments"
                        },
                        {
                            "date": "2020-12-25",
                            "amount": 392.7,
                            "source": "ANZ Investments"
                        }
                    ]
                },
                {
                    "name": "Others",
                    "amount": 2808.58,
                    "recurring": 2808.58,
                    "non_recurring": 0,
                    "total_deposits": 6,
                    "last_10_deposits": [
                        {
                            "date": "2021-02-10",
                            "amount": 169.65,
                            "source": "Bank Deposit"
                        },
                        {
                            "date": "2021-02-10",
                            "amount": 169.65,
                            "source": "MoneyGram"
                        },
                        {
                            "date": "2021-01-10",
                            "amount": 515.22,
                            "source": "Tax Refund"
                        },
                        {
                            "date": "2021-01-10",
                            "amount": 515.22,
                            "source": "Tutoring"
                        },
                        {
                            "date": "2021-01-04",
                            "amount": 719.42,
                            "source": "Bank Deposit"
                        },
                        {
                            "date": "2021-01-04",
                            "amount": 719.42,
                            "source": "Bank Deposit"
                        }
                    ]
                }
            ],
            "accounts": [
                {
                    "bank": "chase",
                    "account_id": 10022206,
                    "account_name": "Joint Savings - 7159",
                    "account_type": "SAVINGS",
                    "average_balance": 80505.01,
                    "current_balance": 95507.4,
                    "available_balance": 95507.4
                },
                {
                    "bank": "chase",
                    "account_id": 10022205,
                    "account_name": "Joint Checking - 9060",
                    "account_type": "CHECKING",
                    "average_balance": 87265.66,
                    "current_balance": 102268.05,
                    "available_balance": 102268.05
                }
            ],
            "rent_payments": null
        },
        {
            "id": "13ac384a-9af7-4269-a3a7-268c251b0bf2",
            "report_url": "https://www.numaly.com/request/...",
            "identity_report_url": "https://www.numaly.com/request/...",
            "paystub_url": "https://www.numaly.com/request/...",
            "request_id": null,
            "request_date": "2022-03-02",
            "response_date": "2022-03-02",
            "from_date": "2021-03-08",
            "to_date": "2022-01-24",
            "days_retrieved": 322,
            "months_retrieved": 11,
            "requester_name": null,
            "first_name": "Dave",
            "last_name": "Sample",
            "currency": "USD",
            "status": "awaiting screening",
            "reference": "Youry Gagarin 8",
            "property_rent": null,
            "email": "dave.sample@numaly.com",
            "phone_number": null,
            "employer": "ABC Company",
            "total_income": "3657.73",
            "income_projection_12_months": "3990.25",
            "average_monthly_income": "332.52",
            "average_monthly_income_last_3": "807.33",
            "total_recurring_income": "0.00",
            "average_monthly_income_recurring": "0.00",
            "total_non_recurring_income": "3657.73",
            "average_monthly_income_non_recurring": "332.52",
            "total_deposits": 11,
            "total_recurring_deposits": 0,
            "total_non_recurring_deposits": 11,
            "income_rent_multiple": null,
            "expense_income_ratio": 1.0,
            "average_monthly_expenses": "332.94",
            "average_days_between_rent_payments": null,
            "applicant_note": "",
            "account_names": "",
            "sources": [
                {
                    "name": "IRS TREAS 310 TAXEIP3 PPD ID: 9111736069",
                    "amount": 1400,
                    "recurring": 0,
                    "non_recurring": 1400,
                    "total_deposits": 1,
                    "last_10_deposits": [
                        {
                            "date": "2021-03-17",
                            "amount": 1400,
                            "source": "IRS TREAS 310 TAXEIP3 PPD ID: 9111736069"
                        }
                    ]
                },
                {
                    "name": "Sample TrnWise 209955466 WEB ID: 453233521",
                    "amount": 689.08,
                    "recurring": 0,
                    "non_recurring": 689.08,
                    "total_deposits": 1,
                    "last_10_deposits": [
                        {
                            "date": "2021-06-01",
                            "amount": 689.08,
                            "source": "Sample TrnWise 209955466 WEB ID: 453233521"
                        }
                    ]
                },
                {
                    "name": "Others",
                    "amount": 1568.65,
                    "recurring": 0,
                    "non_recurring": 1568.65,
                    "total_deposits": 9,
                    "last_10_deposits": [
                        {
                            "date": "2022-01-24",
                            "amount": 2.42,
                            "source": "FEE REVERSAL"
                        },
                        {
                            "date": "2022-01-13",
                            "amount": 6.28,
                            "source": "Sample WISE 290375626 WEB ID: 1453233521"
                        },
                        {
                            "date": "2021-10-12",
                            "amount": 10,
                            "source": "Sample TrnWise 253952294 WEB ID: 453233521"
                        },
                        {
                            "date": "2021-06-17",
                            "amount": 103.79,
                            "source": "Sample TrnWise 215015625 WEB ID: 453233521"
                        },
                        {
                            "date": "2021-06-01",
                            "amount": 424.16,
                            "source": "Sample TrnWise 209952626 WEB ID: 453233521"
                        },
                        {
                            "date": "2021-05-24",
                            "amount": 152.08,
                            "source": "Sample TrnWise 207423214 WEB ID: 453233521"
                        },
                        {
                            "date": "2021-05-05",
                            "amount": 688.46,
                            "source": "Sample TrnWise 202042790 WEB ID: 453233521"
                        },
                        {
                            "date": "2021-04-07",
                            "amount": 180.02,
                            "source": "Sample From mama 193648619 WEB ID: 453233521"
                        },
                        {
                            "date": "2021-03-17",
                            "amount": 1.44,
                            "source": "Govt. Stimulus Chase 30 Day Overdraft Assistance"
                        }
                    ]
                }
            ],
            "accounts": [
                {
                    "bank": "Chase",
                    "account_id": "369ypREqbrHEQd3jLVNoh50aYnNJpJF7RN6gL",
                    "account_name": "CHASE COLLEGE",
                    "account_type": "checking",
                    "average_balance": 243.47,
                    "current_balance": 0,
                    "available_balance": 0
                }
            ],
            "rent_payments": null
        },
...
}
{% endtab %} {% tab title="400" %} ```json { "error": "Invalid request" } ``` {% endtab %} {% endtabs %} # Delete Verification Request Deletes a verification request ## Delete Verification Request `DELETE` `https://api.numaly.com/v1/requests/{id}` #### Path Parameters | Name | Type | Required | Description | | ---- | ------ | -------- | ------------------------------------------------------- | | id | string | True | Either a verification request `id` or your `request_id` | {% tabs %} {% tab title="204 Successfully deleted." %} ``` ``` {% endtab %} {% tab title="404 Verification request not found." %} ``` ``` {% endtab %} {% endtabs %} # Retrieve Report Retrieves the income report data and a url to the report pdf of a completed request. ## Retrieve Report `GET` `https://api.numaly.com/v1/requests/{id}` **Note:** An incomplete report will return empty report fields. Make sure to check for an `awaiting screening` status before parsing the data. #### Path Parameters | Name | Type | Required | Description | | ---- | ------ | -------- | ------------------------------------------------------- | | id | string | true | Either a verification request `id` or your `request_id` | {% tabs %} {% tab title="201 Verification request successfully sent." %} ``` { "id": "1c3f343d-3f21-4c1d-bf53-5939cf42e611", "send_to_applicant" true, "report_url": "https://www.numaly.com/report?id=1c3f343d-3f21-4c1d-bf53-5939cf42e611&token=eyJhbGciOiJIUzUxMiIsImlhdCI6MTYxMzMwMjEzMSwiZXhwIjoxNjEzMzA1NzMxfQ.eyJ1c2VyX2lkIjo0fQ.lLnNNTBKTWyMA0K5D8BZFSA7YNYDVu2fvB8Wrntach6QwJK29CmCRhP4ogdfsJy6rJ2vzjQc9Pgf1pgT_-bS-Q", "identity_report_url: "https://www.numaly.com/report?id=1c3f343d-3f21-4c1d-bf53-5939cf42e611&token=eyJhbGciOiJIUzUxMiIsImlhdCI6MTYxMzMwMjEzMSwiZXhwIjoxNjEzMzA1NzMxfQ.eyJ1c2VyX2lkIjo0fQ.lLnNNTBKTWyMA0K5D8BZFSA7YNYDVu2fvB8Wrntach6QwJK29CmCRhP4ogdfsJy6rJ2vzjQc9Pgf1pgT_-bS-Q" "paystub_url": null, "request_id": null, "request_date": "2021-02-02", "completed_date": "2021-02-06", "from_date": "2020-02-06", "to_date": "2021-02-05", "days_retrieved": 365, "months_retrieved": 12, "requester_name": null, "first_name": "Sarah", "last_name": "Samples", "currency": "USD", "status": "awaiting screening", "reference": "12 Sample Rd", "property_rent": "$700.00", "email": "sarahsample@yahoo.com", "phone_number": null, "identity_accept_tos_status": true "identity_verify_sms_status": true "identity_kyc_check_status": true "identity_document_verification_status": true "identity_selfie_check_status": true "identity_watchlist_screening_status": true "identity_risk_status": true "permitted_verification_method": ['all'] "allow_paystub_upload": true "verify_identity": true "employer": "Abc Hospital", "total_income": "$218,454.00", "income_projection_12_months": "NA", "average_monthly_income": "$18,204.50", "average_monthly_income_last_3_months": "$19,204.5", "total_recurring_income": "$19,727.00", "average_monthly_income_recurring": "$1,643.90", "total_non_recurring_income": "$198,727.00", "average_monthly_income_non_recurring": "$16,560.58", "total_deposits": 62, "total_recurring_deposits": 4, "total_non_recurring_deposits": 58, "income_rent_multiple": "14.10", "expense_income_ratio": null, "average_monthly_expenses": "$1,211.52", "average_days_between_rent_payments": "NA", "applicant_note": null, "account_names": null, "sources":[ { "name": "ABC Hospital", "amount": "$198,727.00", "recurring": "$0.00", "non_recurring": "$198,727.00", "last_10_deposits":[ { "date": "2021-02-03", "source": "Not available", "amount": "$882.79" }, .... ] }, { "name": "Vanguard Dividends", "amount": "$19,727.00", "recurring": "$19,727.00", "non_recurring": "0.00", "last_10_deposits":[ { "date": "2020-02-20", "source": "Vanguard 1770", "amount": "$2,576.53" }, .... ] }, { "name": "Others" "amount": "$3,654.64", "recurring": "$2,978.22", "non_recurring": "$676.42", "last_10_deposits":[ { "date": "2021-01-10", "source": "Amazon", "amount": "$515.22" }, .... ] } ], "accounts":[ { "account_type": "SAVINGS", "available_balance": "$83,644.74", "current_balance": "$83,644.74", "bank": "Dag Site", "account_name": "Joint Savings - 7159", "average_balance": "$80,268.66" }, .... ], "rent_payments":[ { "amount": $800.00, "date": "2020-02-14" }, .... ], "meta_data": {}, } ``` {% endtab %} {% tab title="404 Request not found" %} ``` No response ``` {% endtab %} {% endtabs %} ### Response Schema All fields are calculated using data retrieved between the period `from_date` and `to_date`. All empty field values will return `null` | Field | Type | Response | | -------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | id of the verification request | | `request_id` | string | id of the verification request set by you | | `from_date` | string | How far back the data the income report is generated is generated from. | | `to_date` | string | Date of the most recent transaction the income report is generated from. | | `days_retrieved` | number | Total days of transactions the income report is generated from. It is the delta days of `from_date` and `to_date`. | | `months_retrieved` | number | Total months of transactions the income report is generated from. It is the delta months of `from_date` and `to_date`. | | `requester_name` | string | Name displayed to applicants when completing an income verification. Set by you. | | `first_name` | string | First name of the applicant. | | `last_name` | string | Last name of the applicant. | | `currency` | string | Currency the income report is denoted in. | | `status` | string | Status of the verification request. Either `'awaiting response'`, `'awaiting screening'`, `'accepted'`, `'rejected'`. | | `opened` | boolean | Was a sent verification request click on by the applicant. Note: this defaults to `false` for all verifications started from your link. | | `reference` | string | Reference of the verification request. Set by you. | | `property_rent` | number | Rent for the applied property. | | `email` | string | Applicants email. | | `phone_number` | number | Applicant mobile number. | | `employer` | string | Applicants employment (supplied by them). | | `total_income` | number | Applicants total income in the period between `from_date` and `to_date`. | | `income_projection_12_months` | number | A 12 month income projection if the total income report has less than 12 months of data. (12 ÷`months_retrieved`) x `total_income` | | `average_monthly_income` | number | Average monthly income between the period `from_date` and `to_date`. | | `average_monthly_income_3_months` | number | Average monthly income in the last 3 months. | | `total_recurring_income` | number | Total recurring income between the period `from_date` and `to_date` | | `average_monthly_income_recurring` | number | Average monthly income in the past | | `total_non_recurring_income` | number | Total non-recurring Income between the period `from_date` and `to_date`. | | `average_monthly_income_non_recurring` | number | Average monthly non-recurring income between `from_date` and `to_date`. | | `total_deposits` | number | Total number of deposits into applicants accounts between `from_date` and `to_date`. | | `total_recurring_deposits` | number | Total number of deposits for recurring income between `from_date` and `to_date`. | | `total_non_recurring_deposits` | number | Total number of deposits for non-recurring income between `from_date` and `to_date`. | | `income_rent_multiple` | number | `average_monthly_income` ÷ `property_rent`. | | `expense_income_ratio` | number | `average_monthly_expenses` ÷ `average_monthly_income` | | `average_monthly_expenses` | number | Average total expenses per month between the period `from_date` and `to_date`. | | `average_days_between_rent_payments` | number | The average number of days the between each of the applicants rent payments. | | `applicant_note` | string | A comment left by the applicant on the report. | | `account_names` | string | The names on the applicants bank accounts. | | `sources` | array | An array objects containing information on each of the applicants income sources. | | `accounts` | array | An array objects containing information on each of the applicants accounts with their banks (e.g Checking, Savings ..) | | `rent_payment_history` | array | An array of objects containing each of the applicants rent payments between the period `from_date` and `to_date`. | | `meta_data` | object | The data you supplied when creating your verification link (see start verification tab) | | `request_date` | string | Date verification request was sent to applicant (YYYY-MM-DD). | | `completed_date` | string |

Date verification request was completed by applicant

(YYYY-MM-DD).

| | `report_url` | string | Url to of the income report pdf if it was completed otherwise null. | | `paystub_url` | string | Url of the users paystub if they used to fallback option otherwise null | #### Sources Schema | Field | Type | Description | | --------------- | ------ | -------------------------------------- | | `name` | String | Name of the income source. | | `amount` | number | Total income from source. | | `recurring` | number | Total recurring income from source | | `non-recurring` | number | Total non-recurring income from source | #### Accounts Schema | Field | Type | Description | | ------------------- | ------ | ---------------------------------------------------------------------------- | | `account_id` | string | Id for the account. | | `account_type` | string | Type of account eg. Checking, Savings.. | | `available_balance` | number | Balance available for use. | | `current_balance` | number | Balance unavailable for use. | | `bank` | string | Name of financial institution the account is with. | | `account_name` | string | Name of the account (e.g Freedom Saver etc) | | `average_balance` | number | Average balance of the account between the period `from_date` and `to_date`. | #### Rent Payment History Schema | Field | Type | Description | | -------- | ------ | ------------------------------ | | `amount` | number | Rent amount paid by applicant. | | `date` | string | Date of rent payment. | # Retrieve Joint Report Retrieves a joint income report data and a url to the joint report pdf for multiple applicants. ## Retrieve Joint Report `GET` `https://api.numaly.com/v1/requests/join-requests?ids={id}` #### Query Parameters | Name | Type | Required | Description | | ---- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ids | string | True | Either a verification request `id` or you `request_id` of the verifications you wish to create a report for. For multiple ids or request\_ids use seperate them with commas e.g `1,2,3` | {% tabs %} {% tab title="200 " %} ``` { "joint_report_url": "https://www.numaly.com/report?token=eyJhbGciOiJIUzUxMiIsImlhdCI6MTYxMzMwMjEzMSwiZXhwIjoxNjEzMzA1NzMxfQ.eyJ1c2VyX2lkIjo0fQ.lLnNNTBKTWyMA0K5D8BZFSA7YNYDVu2fvB8Wrntach6QwJK29CmCRhP4ogdfsJy6rJ2vzjQc9Pgf1pgT_-bS-Q&id_1=1c3f343d-3f21-4c1d-bf53-5939cf42e611&id_2=4b7G113v-3f21-4c1d-bf53-5939cf42e611" "joint_names": "Sarah Samples, John Samples", "from_date": "2020-02-06", "to_date": "2021-02-05", "months_retrieved": 12, "days_retrieved": 365 "total_income": "$204,954.00", "total_deposits": 18, "average_monthly_income": "$17,079.50", "average_monthly_income_3": "$16,165.85", "average_monthly_expenses": "$6,954.00", "total_recurring_income": 98,300.50, "average_monthly_income_recurring": "$9,100.00", "total_recurring_deposits": 10, "total_non_recurring_income": "206,653.50" , "average_monthly_income_non_recurring": "7,979.50", "total_non_recurring_deposits": 8, "income_rent_multiple": 15.53, "expense_income_ratio": 0.41, "property_rent": "$1,100.00" "applicants": [ individual reports ...] } ``` {% endtab %} {% tab title="403 Returned if there are more than 10 applicants in the joint report" %} ``` ``` {% endtab %} {% tab title="404 Returned when either a verification id could not be found, if one of the verification was not complete or if one of the verifications was completed with a paystub." %} ``` No response ``` {% endtab %} {% endtabs %} ids is a comma separated string of request ids needed for the joint report ### Response Schema | Field | Type | Response | | ---------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Joint Names | String | Names of all applicants the joint summary is for. | | from\_date | string | How far back the data the income report is generated is generated from. | | to\_date | string | Date of the most recent transaction the income report is generated from. | | months\_retrieved | number | Total months of transactions the income report is generated from. It is the delta months of `from_date` and `to_date`. Will always use the applicant with the longest report period. | | days\_retrieved | number | Total days of transactions the income report is generated from. It is the delta days of `from_date` and `to_date`. Will always use the applicant with the longest report period. | | total\_income | number | Total combined income for all applicants in the period between `from_date` and `to_date`. | | total\_deposits | number | Total number of deposits into applicants accounts between `from_date` and `to_date`. | | average\_monthly\_income | number | Average combined monthly income between the period `from_date` and `to_date`. | | average\_monthly\_income\_3 | number | Average combined monthly income in the last 3 months. | | average\_monthly\_expenses | number | Average combined monthly expenses. | | total\_recurring\_income | number | Total combined recurring income. | | average\_monthly\_income\_recurring | number | Average monthly combined recurring income. | | total\_recurring\_deposits | number | Total recurring deposits for all applicants. | | total\_non\_recurring\_income | number | Total combined non-recurring income. | | average\_monthly\_income\_non\_recurring | number | Average combined non-recurring monthly income. | | total\_non\_recurring\_deposits | number | Total non-recurring deposits for all applicants. | | income\_rent\_multiple | number | `average_monthly_income` ÷ `income_rent` | | expense\_income\_ratio | number | `average_monthly_expenses` ÷ `average_monthly_income` | | Applicants | array | An array of objects containing a individual report for each applicant in the joint report. | | joint\_report\_url | string | Url link to the joint report pdf. |