๐Ÿ“Get Quote

Submit a shorter application to get an indicative quotes from the lenders on the Fincheck Engine platform. The applicant becomes a lead in the lender's ecosystem and can be redirected to the lender's

Get Offers - (Get Quote)

Get Offers - (Get Quote)

POST {{baseUrl}}/api/v1/offer

Submit a shorter application to get an indicative quotes from the lenders on the Fincheck Engine platform. The applicant becomes a lead in the lender's ecosystem and can be redirected to the lender's environment to complete their application and provide the outstanding details and documents.

Request Body

NameTypeDescription

application_method*

String

"apply-now" or "get-quote". Indicates the type of loan application the applicant wishes to make.

fast_application*

boolean

employed*

boolean

This bool indicates whether or not the applicant is formally employed.

payday*

integer

This is the day of the month on which the applicant routinely gets paid.

bank_name*

String

This is the slug of the bank that the applicant uses (this needs to match the slug used for "bank" in the Affordability v1 module > Create new Bank Account).

intent_id*

integer

An intent_id is assigned to a specific product in Fincheck Engine. The intent_id for personal loans is "2". The value will always be "2" in the Apply Now request (as it is for personal loans only).

popi

boolean

expenses*

integer

The expenses incurred by the customer in a month. This can be taken from the Summary Plus.

gross_income*

integer

The income before tax earned by the applicant.

email*

String

The applicant's email address that they have access to and monitor regularly.

cell_phone_number*

String

The applicant's primary cellphone number that can be used to contact them.

id_number*

String

The applicant's South African ID number as per their ID document.

last_name*

String

The last name/surname/family name of the applicant as per their ID document.

middle_name

String

The middle name of the applicant as per their ID document.

first_name*

String

The first name of the applicant as per their ID document.

payment_frequency*

String

How often the applicant will make payments in settlement of the loan (i.e. the intervals in which payments will be made, e.g. weekly, fortnightly, monthly, etc.)

repayment_period*

integer

Number of months the applicant would like repay the loan over.

loan_amount_required*

integer

The amount the applicant would like to lend.

net_income*

integer

The income after tax received by the applicant into their bank account.

```json
{
    "matches": [
        {
            "id": 145,
            "company_name": "Finchoice",
            "company_logo_path": "images/partners/145/logo/3Tjd9pB3daPadd6GOgiqzPX9J9jvGO32lyTcVxtv.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/145/logo/3Tjd9pB3daPadd6GOgiqzPX9J9jvGO32lyTcVxtv.png",
            "company_website_url": "https://www.finchoice.co.za",
            "rank": "4",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": {
                "offers": [
                    {
                        "id": 31,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 24,
                        "InterestRate": 28,
                        "ProductDescription": "24 Month Personal",
                        "min": 500,
                        "max": 18000,
                        "LoanAmount": 18000,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadNL&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=lDxgER+f2WBX+V421akAtBcXVLSQS014fpUSEPyNoZg=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    },
                    {
                        "id": 32,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 12,
                        "InterestRate": 28,
                        "ProductDescription": "12 Month Flexi",
                        "min": 500,
                        "max": 18000,
                        "LoanAmount": 18000,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadNL&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=WpJi64S7Z2cddkSO09zactsMYrWgq5L05HM22MiXd8Y=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    },
                    {
                        "id": 33,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 6,
                        "InterestRate": 0,
                        "ProductDescription": "6 Month Flexi",
                        "min": 500,
                        "max": 7500,
                        "LoanAmount": 7500,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadNL&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=goSTjz4ZdDnLtu4tmbA9Toz+ZbJGBfuT8vt/0nnOU6A=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    },
                    {
                        "id": 41,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 1,
                        "InterestRate": 28,
                        "ProductDescription": "KwikAdvance",
                        "min": 100,
                        "max": 2000,
                        "LoanAmount": 2000,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadNL&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=HbxCYv3N2dG+3kyG82OcQs61IODOzEMbsWFz52K1Z4c=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    },
                    {
                        "id": 45,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 3,
                        "InterestRate": 0,
                        "ProductDescription": "MobiMoney",
                        "min": 200,
                        "max": 6000,
                        "LoanAmount": 6000,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadMM&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=BKd3dApQemMuJ8MVYuascmLp2UYGAigxdKO2mIuOsxU=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    }
                ],
                "type": "multipleOffers"
            },
            "end_to_end": true,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 77,
            "company_name": "Capfin",
            "company_logo_path": "storage/images/partners/77/logo/jordggtabtbtvgvc.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/77/logo/jordggtabtbtvgvc.png",
            "company_website_url": "https://www.capfin.co.za/apply-now/application-details?a=CF0000104",
            "rank": "8",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": {
                "offers": [
                    {
                        "type": "detailedCard",
                        "TermAllowed": 24,
                        "LoanAmount": 50000,
                        "InterestRate": 27.75
                    }
                ]
            },
            "end_to_end": false,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 98, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 147,
            "company_name": "Boodle",
            "company_logo_path": "images/partners/147/logo/F8rW0F77uxenwTgGWUTsq7cQLWWde5DVPQ8zf22k.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/147/logo/F8rW0F77uxenwTgGWUTsq7cQLWWde5DVPQ8zf22k.png",
            "company_website_url": "https://www.boodle.co.za",
            "rank": "5",
            "company_mini_logo_url": "https://dev.engine.fincheck.co.za/api/partner/147/logo/mini/Boodle Logo 150px 24012022.jpg",
            "company_wide_logo_url": "https://dev.engine.fincheck.co.za/api/partner/147/logo/wide/F8rW0F77uxenwTgGWUTsq7cQLWWde5DVPQ8zf22k (1).png",
            "probability": 90,
            "live_score": -2,
            "end_to_end": true,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 15000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 194,
            "company_name": "Boodle",
            "company_logo_path": "api/partner/194/logo/boodle.png",
            "company_logo_url": "https://dev.engine.fincheck.co.za/api/partner/194/logo/boodle.png",
            "company_website_url": "https://boodle.co.za",
            "rank": "2",
            "company_mini_logo_url": "https://dev.engine.fincheck.co.za/api/partner/194/logo/mini/Boodle mini.jpeg",
            "company_wide_logo_url": "https://dev.engine.fincheck.co.za/api/partner/194/logo/wide/boodle.png",
            "probability": 90,
            "end_to_end": false,
            "userable": {
                "partner_type": "url",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 15000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 12,
            "company_name": "MPOWA Finance",
            "company_logo_path": "images/partners/12/logo/rg96EJuFICzxruUBI1npBvlBwlfMSFwyzLoRhrAI.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/12/logo/rg96EJuFICzxruUBI1npBvlBwlfMSFwyzLoRhrAI.png",
            "company_website_url": null,
            "rank": "3",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": -2,
            "end_to_end": true,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 80, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 183,
            "company_name": "Sunshine Loans",
            "company_logo_path": "api/partner/183/logo/image (4).png",
            "company_logo_url": "https://dev.engine.fincheck.co.za/api/partner/183/logo/image (4).png",
            "company_website_url": "https://sunshineloans.com",
            "rank": "2",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "end_to_end": false,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 5000, \"results\": 80, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 116,
            "company_name": "Lime",
            "company_logo_path": "images/partners/116/logo/AfKj7Nh1hnL8EMzNyXNyp1VZXBiANQkj0Qpeibou.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/116/logo/AfKj7Nh1hnL8EMzNyXNyp1VZXBiANQkj0Qpeibou.png",
            "company_website_url": "https://www.konga24.co.za/",
            "rank": "6",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": {
                "url": "https://trk.lime24za.com/click?offer_id=3&pid=119&sub1=CLICK_ID_HERE&sub3=SOURCE_HERE"
            },
            "end_to_end": false,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 112,
            "company_name": "African Bank",
            "company_logo_path": "api/partner/112/logo/ABW2201_018_ABLogo_NoTagLine_FinCheck_300x150px.jpeg",
            "company_logo_url": "https://dev.engine.fincheck.co.za/api/partner/112/logo/ABW2201_018_ABLogo_NoTagLine_FinCheck_300x150px.jpeg",
            "company_website_url": "https://africanbank.co.za/",
            "rank": "1",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": {
                "offers": [
                    {
                        "type": "detailedCard",
                        "TermAllowed": 72,
                        "LoanAmount": 350000,
                        "InterestRate": 0
                    }
                ]
            },
            "end_to_end": false,
            "userable": {
                "partner_type": "url",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        }
    ],
    "id": "WDPod5"
}
```
```json
{
    "matches": [
        {
            "id": 145,
            "company_name": "Finchoice",
            "company_logo_path": "images/partners/145/logo/3Tjd9pB3daPadd6GOgiqzPX9J9jvGO32lyTcVxtv.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/145/logo/3Tjd9pB3daPadd6GOgiqzPX9J9jvGO32lyTcVxtv.png",
            "company_website_url": "https://www.finchoice.co.za",
            "rank": "4",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": {
                "offers": [
                    {
                        "id": 31,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 24,
                        "InterestRate": 28,
                        "ProductDescription": "24 Month Personal",
                        "min": 500,
                        "max": 18000,
                        "LoanAmount": 18000,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadNL&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=lDxgER+f2WBX+V421akAtBcXVLSQS014fpUSEPyNoZg=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    },
                    {
                        "id": 32,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 12,
                        "InterestRate": 28,
                        "ProductDescription": "12 Month Flexi",
                        "min": 500,
                        "max": 18000,
                        "LoanAmount": 18000,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadNL&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=WpJi64S7Z2cddkSO09zactsMYrWgq5L05HM22MiXd8Y=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    },
                    {
                        "id": 33,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 6,
                        "InterestRate": 0,
                        "ProductDescription": "6 Month Flexi",
                        "min": 500,
                        "max": 7500,
                        "LoanAmount": 7500,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadNL&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=goSTjz4ZdDnLtu4tmbA9Toz+ZbJGBfuT8vt/0nnOU6A=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    },
                    {
                        "id": 41,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 1,
                        "InterestRate": 28,
                        "ProductDescription": "KwikAdvance",
                        "min": 100,
                        "max": 2000,
                        "LoanAmount": 2000,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadNL&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=HbxCYv3N2dG+3kyG82OcQs61IODOzEMbsWFz52K1Z4c=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    },
                    {
                        "id": 45,
                        "entityId": "BAL26022",
                        "type": "detailedCard",
                        "TermAllowed": 3,
                        "InterestRate": 0,
                        "ProductDescription": "MobiMoney",
                        "min": 200,
                        "max": 6000,
                        "LoanAmount": 6000,
                        "url": "https://uat.finchoice.mobi/stage/Registration/LeadGenerationRedirect?AccountType=LeadMM&EntityID=ehwLSNNDd637PDEYefOHsR9cPPW/JW4ESkc8zQVmgg4=&ProviderName=BKd3dApQemMuJ8MVYuascmLp2UYGAigxdKO2mIuOsxU=",
                        "responseGuid": "7f2a23ab-4c66-407e-9ede-f69bd56bd394",
                        "bureauExpenses": 0,
                        "isNewloanEntity": false
                    }
                ],
                "type": "multipleOffers"
            },
            "end_to_end": true,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 77,
            "company_name": "Capfin",
            "company_logo_path": "storage/images/partners/77/logo/jordggtabtbtvgvc.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/77/logo/jordggtabtbtvgvc.png",
            "company_website_url": "https://www.capfin.co.za/apply-now/application-details?a=CF0000104",
            "rank": "8",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": {
                "offers": [
                    {
                        "type": "detailedCard",
                        "TermAllowed": 24,
                        "LoanAmount": 50000,
                        "InterestRate": 27.75
                    }
                ]
            },
            "end_to_end": false,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 98, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 147,
            "company_name": "Boodle",
            "company_logo_path": "images/partners/147/logo/F8rW0F77uxenwTgGWUTsq7cQLWWde5DVPQ8zf22k.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/147/logo/F8rW0F77uxenwTgGWUTsq7cQLWWde5DVPQ8zf22k.png",
            "company_website_url": "https://www.boodle.co.za",
            "rank": "5",
            "company_mini_logo_url": "https://dev.engine.fincheck.co.za/api/partner/147/logo/mini/Boodle Logo 150px 24012022.jpg",
            "company_wide_logo_url": "https://dev.engine.fincheck.co.za/api/partner/147/logo/wide/F8rW0F77uxenwTgGWUTsq7cQLWWde5DVPQ8zf22k (1).png",
            "probability": 90,
            "live_score": -2,
            "end_to_end": true,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 15000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 194,
            "company_name": "Boodle",
            "company_logo_path": "api/partner/194/logo/boodle.png",
            "company_logo_url": "https://dev.engine.fincheck.co.za/api/partner/194/logo/boodle.png",
            "company_website_url": "https://boodle.co.za",
            "rank": "2",
            "company_mini_logo_url": "https://dev.engine.fincheck.co.za/api/partner/194/logo/mini/Boodle mini.jpeg",
            "company_wide_logo_url": "https://dev.engine.fincheck.co.za/api/partner/194/logo/wide/boodle.png",
            "probability": 90,
            "end_to_end": false,
            "userable": {
                "partner_type": "url",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 15000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 12,
            "company_name": "MPOWA Finance",
            "company_logo_path": "images/partners/12/logo/rg96EJuFICzxruUBI1npBvlBwlfMSFwyzLoRhrAI.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/12/logo/rg96EJuFICzxruUBI1npBvlBwlfMSFwyzLoRhrAI.png",
            "company_website_url": null,
            "rank": "3",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": -2,
            "end_to_end": true,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 80, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 183,
            "company_name": "Sunshine Loans",
            "company_logo_path": "api/partner/183/logo/image (4).png",
            "company_logo_url": "https://dev.engine.fincheck.co.za/api/partner/183/logo/image (4).png",
            "company_website_url": "https://sunshineloans.com",
            "rank": "2",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "end_to_end": false,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 5000, \"results\": 80, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 116,
            "company_name": "Lime",
            "company_logo_path": "images/partners/116/logo/AfKj7Nh1hnL8EMzNyXNyp1VZXBiANQkj0Qpeibou.png",
            "company_logo_url": "https://engine.fincheck.co.za/api/partner/116/logo/AfKj7Nh1hnL8EMzNyXNyp1VZXBiANQkj0Qpeibou.png",
            "company_website_url": "https://www.konga24.co.za/",
            "rank": "6",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": {
                "url": "https://trk.lime24za.com/click?offer_id=3&pid=119&sub1=CLICK_ID_HERE&sub3=SOURCE_HERE"
            },
            "end_to_end": false,
            "userable": {
                "partner_type": "api",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        },
        {
            "id": 112,
            "company_name": "African Bank",
            "company_logo_path": "api/partner/112/logo/ABW2201_018_ABLogo_NoTagLine_FinCheck_300x150px.jpeg",
            "company_logo_url": "https://dev.engine.fincheck.co.za/api/partner/112/logo/ABW2201_018_ABLogo_NoTagLine_FinCheck_300x150px.jpeg",
            "company_website_url": "https://africanbank.co.za/",
            "rank": "1",
            "company_mini_logo_url": null,
            "company_wide_logo_url": null,
            "probability": 98,
            "live_score": {
                "offers": [
                    {
                        "type": "detailedCard",
                        "TermAllowed": 72,
                        "LoanAmount": 350000,
                        "InterestRate": 0
                    }
                ]
            },
            "end_to_end": false,
            "userable": {
                "partner_type": "url",
                "probability_conditions": "[{\"field\": \"gross_income\", \"value\": 15000, \"results\": 98, \"operator\": \"greater_than\"}, {\"field\": \"gross_income\", \"value\": 7000, \"results\": 90, \"operator\": \"greater_than\"}]"
            }
        }
    ],
    "id": "WDPod5"
}
```

Interpreting the 200: OK response

"live_score"
  • If there is no "live_score" it means that it is no live offer for the given offer id.

  • -2 means that this is not a live offer for this offer id.

  • If there is a live score object (e.g. below), this means that it is a live offer

...
"live_score": {
                "offers": [
                    {
                        "type": "detailedCard",
                        "TermAllowed": 72,
                        "LoanAmount": 350000,
                        "InterestRate": 0
                    }
                ]
            },
...
"id" (integer)

Refers to the offer_id that is one of many offers in the response body.

"id" (string) --> "hashid"

Refers to the response as a whole or the instance of the "application".

Last updated