Guides

First API Call

Step-by-step instructions for setting a request to the Falcon API.

Suggest Edits

Step 1: Retrieve Authorization Token

Refer to Authentication and retrieve your API authentication token by contacting Falcon Support Team.

📘

Point to Ponder

Be sure and switch to the Falcon UAT Environment in Postman or any other API tool and add use the API token to hit endpoints successfully.

Step 2: Test Endpoint

Using your preferred REST API testing tool make sure you are hitting the Falcon API endpoint.

📘

Multi-Language Samples

Here at Falcon API documentation; we will always give out sample codes in different development languages to support the majority of the developers. The API References endpoints have more than 20 programming languages.

curl --location --request POST 'https://stage.tab.kitecash.in/open-api/falcon/v1/user' \
--header 'Authorization: Basic c2ltYmE6c2ltYmE=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "rajat",
    "lastName": "Singhal",
    "mobileNumber": "9717798661",
    "dateOfBirth": "1966-01-01",
    "gender": "FEMALE",
    "marriedStatus": "SINGLE",
    "address" : {
        "kycAddress": {
            "address1": "S/O Dalchand",
            "address2": "1069",
            "address3": "mahaveer nagar first I L",
            "city": "Kota",
            "state": "Rajasthan",
            "pinCode": "324005"
        },
        "deliveryAddress": {
            "address1": "S/O Dachand",
            "address2": "1069",
            "address3": "mahaveer nagar first I L",
            "city": "Kota",
            "state": "Rajasthan",
            "pinCode": "324005"
        }
    }
}'

📘

Content-Type

The Content-Type header parameter for all the endpoints containing a body should be set to application/json

Step 3: Retrieve Result

A usual 200 response should look something like this:

{
    "id": "4e34b8f5-5efa-4d54-8d5c-4c4ccda50052",
    "firstName": "rajat",
    "lastName": "Singhal",
    "dateOfBirth": "1966-01-01",
    "gender": "FEMALE",
    "marriedStatus": "SINGLE",
    "address": {
        "kycAddress": {
            "address1": "S/O Dalchand",
            "address2": "1069",
            "address3": "mahaveer nagar first I L",
            "city": "Kota",
            "state": "Rajasthan",
            "pinCode": "324005"
        },
        "deliveryAddress": {
            "address1": "S/O Dachand",
            "address2": "1069",
            "address3": "mahaveer nagar first I L",
            "city": "Kota",
            "state": "Rajasthan",
            "pinCode": "324005"
        }
    }
}

Updated almost 3 years ago