Make Your First API Call

Send a request to Rapyd's API

There are several steps you will need to complete before you can send your first API request to the Rapyd platform.

Step 1 - Create a Rapyd account here.

Step 2 - Using your preferred REST API testing tool (such as Postman) let’s make sure that you are actually hitting the Rapyd endpoint.

Send this HTTP GET call to see if you get an authentication error:

GET https://sandboxapi.rapyd.net/v1/data/countries

You should receive an error message similar to this:

{
    "status": {
        "error_code": "MISSING_AUTHENTICATION_HEADERS",
        "status": "ERROR",
        "message": "The request did not contain the required headers for authentication. The request was rejected. Corrective action: Add authentication headers.",
        "response_code": "MISSING_AUTHENTICATION_HEADERS",
        "operation_id": "cb1d06f6-7f8d-480e-9df2-5f210a1dc86e"
    }
}

Step 3 - From your sandbox account, locate your Secret key and Access key. You can find these by selecting “Developers” from the left hand navigation. NOTE: there is a Sandbox toggle on the bottom of the navigation bar, use this to view your sandbox or production credentials.

Step 4 - Set up your Authentication Headers including your Request Signature. The Rapyd Request Headers are: access_key, content-Type, salt, signature, and timestamp. For more Header details visit the List Countries page in our API reference. NOTE: some API calls have their own set of headers, you can find more details in the API reference for each api endpoint.

Step 5 - Calculate your Request Signature, which is one of the authentication headers. You will need to BASE64 encode (with URL safe encoding) a HASH output using HMAC-SHA256.

The formula for calculating the signature is:
signature = BASE64 ( HASH ( http_method + url_path + salt + timestamp + access_key + secret_key + body_string ) )

For more details, including different Request Signatures in a variety of programming languages visit the Request Signatures page in our API reference to learn how to construct your Request Signature.

Step 6 - Now that you have generated your Request Signature and set up your Authentication Headers, you are ready to send a HTTP GET Request to Rapyd.

Calling list countries using HTTP GET

To start, we recommend using the request “list countries” GET method.

GET https://sandboxapi.rapyd.net/v1/data/countries

Your response should look something like this:

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "eda93fb4-fc97-4907-a282-c9676b37436a"
    },
    "data": [
        {
            "id": 379,
            "name": "Albania",
            "iso_alpha2": "AL",
            "iso_alpha3": "ALB",
            "currency_code": "ALL",
            "currency_name": "Albanian lek",
            "currency_sign": "L",
            "phone_code": "355"
        },
        {
            "id": 132,
            "name": "Andorra",
            "iso_alpha2": "AD",
            "iso_alpha3": "AND",
            "currency_code": "EUR",
            "currency_name": "Euro",
            "currency_sign": "€",
            "phone_code": "376"
        },
        {
            "id": 133,
            "name": "Angola",
            "iso_alpha2": "AO",
            "iso_alpha3": "AGO",
            "currency_code": "AOA",
            "currency_name": "Angolan kwanza",
            "currency_sign": "Kz",
            "phone_code": "244"
        },
        
        //...etc...

📘

Still not able to successfully send a request to the Rapyd API?

Contact Rapyd Customer Support.

Updated about a month ago


Make Your First API Call


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.