Sorry, you need to enable JavaScript to visit this website.

5 Get reference data

Action

Using the heavy access token you received from the previous step, call the reference data endpoint to get reference data you will use to build up the pre-approval request.


Method GET
Endpoint https://api.nedbank.co.za/apimarket/sandbox/nb-home-loans/api/open-banking/GetReferencedata
Request
Headers
Header Value Description
Authorization Bearer <ACCESS_TOKEN> Replace with the heavy/submission access token you received from the previous call.
x-ibm-client-id <YOUR CLIENT ID> The client ID you received when creating the app on the portal.
x-ibm-client-secret <YOUR CLIENT SECRET> The client secret you received when creating the app on the portal.
Response JSON
                            
{
    "Reference_Data": {
        "PropertyUsage": [
            {
                "code": "1",
                "description": "Primary / Permanent residence"
            },
            {
                "code": "2",
                "description": "Secondary residence: e.g. a holiday home"
            },
            {
                "code": "3",
                "description": "An Investment: e.g. to rent out"
            }
        ],
        "MarriageType": [
            {
                "code": "01",
                "description": "Married in community of property (COP)"
            },
            {
                "code": "02",
                "description": "Married out of COP"
            }
        ],
        "MaritalStatus": [
            {
                "code": "U",
                "description": "Single"
            },
            {
                "code": "M",
                "description": "Married"
            },
            {
                "code": "D",
                "description": "Divorced"
            },
            {
                "code": "W",
                "description": "Widowed"
            },
            {
                "code": "O",
                "description": "Other"
            }
        ],
        "ApplicantType": [
            {
                "code": "1",
                "title": "Me alone",
                "description": "Person responsible for the loan will be me alone. "
            },
            {
                "code": "3",
                "title": "Me and a co-applicant/s",
                "description": "Person responsible for the loan will be me and other co-applicants"
            }
        ],
        "LoanType": [
            {
                "code": "1",
                "description": "First loan"
            },
            {
                "code": "4",
                "description": "Re-advance"
            },
            {
                "code": "6",
                "description": "Further loan"
            }
        ],
        "LoanTypeReason": [
            {
                "code": "1",
                "description": "Property purchase"
            },
            {
                "code": "10",
                "description": "Building loan"
            },
            {
                "code": "16",
                "description": "Buying from a developer"
            },
            {
                "code": "3",
                "description": "Switch to Nedbank"
            },
            {
                "code": "4",
                "description": "Existing unbonded property"
            }
        ],
        "PropertyType": [
            {
                "code": "4",
                "description": "House",
                "isActive": true,
                "isSectional": true,
                "name": "House"
            },
            {
                "code": "5",
                "description": "Apartment",
                "isActive": true,
                "isSectional": true,
                "name": "ApartmentOrFlat"
            },
            {
                "code": "6",
                "description": "Townhouse",
                "isActive": true,
                "isSectional": true,
                "name": "Townhouse"
            }
        ],
        "LoanOrigin": [
            {
                "code": "36",
                "segment": "NPW",
                "description": "NPW"
            },
            {
                "code": "06",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "16",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "66",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "76",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "02",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "12",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "22",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "32",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "42",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "52",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "62",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "72",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "82",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "92",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "21",
                "segment": "RRB",
                "description": "RRB"
            },
            {
                "code": "Default",
                "segment": "Retail",
                "description": "Retail"
            }
        ]
    }
}