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

4 Retrieve applications for buyers

Action

Retrieve applications that are linked to the specified south african identity number as a buyer.

Only applications created by/linked to your client id will be returned.


Method GET
Endpoint https://api.nedbank.co.za/apimarket/sandbox/vehicleassetfinance/v1/buyer/{idnumberoremail}
Request
Headers
Header Value Description
x-mfc-worklow true or false Whether or not to include the application workflow information in application response.
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.
Query parameters
Parameter Value Description
idnumberoremail <BUYER'S RSA IDENTITY NUMBER OR EMAIL ADDRESS> The south africa identity number or email address for which applications should be returned. In the case of an email address the value must be url encoded. (the encoding for an @ symbol is %40)
Response JSON
                            
 {
    "data": [
        {
            "ageInDays": 25,
            "applicationStatus": "InProgress",
            "applicationStatusDetail": {
                "color": "#009639",
                "description": "Your application has not yet been submitted.",
                "key": "inprogress",
                "name": "In Progress",
                "order": 2
            },
            "bankStatementsConsent": false,
            "buyerCellphone": "0632540410",
            "buyerIdentityNumber": "7801270109089",
            "canCancel": false,
            "canResume": false,
            "canView": false,
            "creditConsent": true,
            "currentState": "Vehicle",
            "currentStateDetail": {
                "category": "Affordability",
                "categoryVisible": true,
                "isComplete": false,
                "isCurrent": true,
                "isLocked": false,
                "lockPriorToState": false,
                "name": "Vehicle details",
                "order": 100,
                "state": "Vehicle",
                "static": false,
                "submitPriorToState": false,
                "url": "vehicle",
                "userType": "Buyer"
            },
            "currentBuyerState": "Vehicle",
            "currentBuyerStateDetail": {
                "category": "Affordability",
                "categoryVisible": true,
                "isComplete": false,
                "isCurrent": true,
                "isLocked": false,
                "lockPriorToState": false,
                "name": "Vehicle details",
                "order": 100,
                "state": "Vehicle",
                "static": false,
                "submitPriorToState": false,
                "url": "vehicle",
                "userType": "Buyer"
            },
            "dealType": "Dealer",
            "displayMigrationAlert": false,
            "buyerDocumentationProcessed": false,
            "sellerDocumentationProcessed": false,
            "foxSubmitRequired": false,
            "monthlyExpensesCaptured": false,
            "payslipConsent": true,
            "sellerContactCaptured": true,
            "userType": 0,
            "bankerEmail": "",
            "crossSellConsent": true,
            "applicationSeedId": 0,
            "notifyUsers": true,
            "createdDate": "2019-09-12T10:50:22.3962364",
            "modifiedDate": "2019-09-12T10:50:22.3962364",
            "id": 1,
            "populated": false
        }
    ],
    "metaData": {
        "code": "R00",
        "message": "Operation successful.",
        "name": "Success"
    }
}