BIN/IIN Lookup - Greip API Documentation

GET

lookup

bin

curl --request GET \
  --url https://greipapi.com/lookup/bin \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "reason": "",
    "isValid": true,
    "blacklisted": false,
    "bin": "456789",
    "info": {
      "scheme": {
        "name": "Visa",
        "coName": "Mada",
        "isLuha": true,
        "isPrepaid": false,
        "isCommercial": false,
        "type": "debit",
        "brand": "Traditional",
        "currency": "SAR"
      },
      "detected_digits": "4",
      "syntax": {
        "gaps": [4, 8, 12],
        "lengths": [16, 18, 19],
        "code": {
          "name": "CVV",
          "size": 3
        }
      },
      "bank": {
        "id": "588847",
        "identifier": "80",
        "name": "AL RAJHI BANKING AND INVESTMENT CORP.",
        "city": "Riyadh",
        "url": "https://www.alrajhibank.com.sa",
        "phone": "+96611211600",
        "logo": "https://greip.io/img/banks/al-rajhi.jpg",
        "latitude": "25",
        "longitude": "45"
      },
      "country": {
        "alpha2": "SA",
        "name": "Saudi Arabia",
        "code": "966",
        "numeric": "682",
        "emoji": "🇸🇦",
        "continent": "Asia",
        "languageCode": "ar",
        "languageNative": "العربية"
      }
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "status": "success",
  "executionTime": 2
}

Overview

The IIN (Issuer Identification Number), also known as the BIN (Bank Identification Number), is the first 6 digits of a debit or credit card number. These unique numbers are used to identify the issuing entity, such as the bank or financial institution that issued the card.

One of the most common and critical use cases of this method is to detect and prevent fraud payments in your app or website. This is an essential task for any business that accepts online payments, as fraud can lead to significant financial losses and reputational damage.

For example, based on of our case studies, if you notice a user from the UK purchasing large amounts of your product, and the card used for payment is issued by a bank located in the US, this could be a red flag. This may indicate that the user is using a stolen or fraudulent card to complete the checkout process. By flagging such transactions for review or rejection, you can prevent fraud and protect your business from financial loss.

Query Parameters

bin

string

required

The BIN/IIN of the card (min: 6 digits).

Sample value: 456789, 456789XXXXXX1234, or 4567891234567890.

format

string

default:"JSON"

The format command is used to get a response in a specific format.

Expected values: JSON, XML, CSV, or Newline

For more information please refer to Response Format.

mode

string

default:"live"

The mode command is used to in the development stage to simulate the integration process before releasing it to the production environment.

Expected values: live, or test.

For more information please refer to Development Environment.

userID

string

The userID command can be used to identify requests sent by specific users to monitor in the Events Page.

Expected values: email address, phone number, user id, name, etc.

For more information please refer to User Identifier.

callback

string

The callback command can help you make the response as a JSONP format.

Expected values: any name that can be used as a function name in Javascript, e.g: myFunctionName.

For more information please refer to JSONP Callback.

{
  "data": {
    "reason": "",
    "isValid": true,
    "blacklisted": false,
    "bin": "456789",
    "info": {
      "scheme": {
        "name": "Visa",
        "coName": "Mada",
        "isLuha": true,
        "isPrepaid": false,
        "isCommercial": false,
        "type": "debit",
        "brand": "Traditional",
        "currency": "SAR"
      },
      "detected_digits": "4",
      "syntax": {
        "gaps": [4, 8, 12],
        "lengths": [16, 18, 19],
        "code": {
          "name": "CVV",
          "size": 3
        }
      },
      "bank": {
        "id": "588847",
        "identifier": "80",
        "name": "AL RAJHI BANKING AND INVESTMENT CORP.",
        "city": "Riyadh",
        "url": "https://www.alrajhibank.com.sa",
        "phone": "+96611211600",
        "logo": "https://greip.io/img/banks/al-rajhi.jpg",
        "latitude": "25",
        "longitude": "45"
      },
      "country": {
        "alpha2": "SA",
        "name": "Saudi Arabia",
        "code": "966",
        "numeric": "682",
        "emoji": "🇸🇦",
        "continent": "Asia",
        "languageCode": "ar",
        "languageNative": "العربية"
      }
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "status": "success",
  "executionTime": 2
}

Response properties

data

object

required

Hide properties

reason

string

required

Reason for the validation result.

isValid

boolean

required

Validation result (true or false).

blacklisted

boolean

required

Indicates if the BIN is blacklisted due to applying custom rules or were found in one of your blacklists.

bin

string

required

The BIN/IIN of the card you passed in the request.

info

object

required

Hide properties

scheme

object

required

Hide properties

name

object

required

Card scheme name.

coName

object

required

Card company name.

isLuha

boolean

required

Is the card issued by Luha?

isPrepaid

boolean

required

Is the card prepaid?

isCommercial

boolean

required

Is the card commercial?

type

string

required

Card type (debit, or credit).

brand

string

required

Card brand (Traditional, Gold, Platinum, etc.).

currency

string

required

Card currency.

detected_digits

string

required

The digits used to detect the scheme details.

syntax

object

required

Hide properties

gaps

array

required

The gaps variations of the card number.

lengths

array

required

The possible lengths of the card number.

code

object

required

Hide properties

name

string

required

The name of the code (e.g: CVV).

size

integer

required

The number of digits in the code.

bank

object

required

Hide properties

string

required

Bank ID.

identifier

string

required

Bank identifier.

name

string

required

The official bank name.

city

string

required

The city where the bank’s headquarters are located.

url

string

required

Bank URL of the official website.

phone

string

required

Bank phone number for contact.

logo

string

required

Bank logo URL (image).

latitude

string

required

Bank latitude coordinates of the country where the bank is located.

longitude

string

required

Bank longitude coordinates of the country where the bank is located.

country

object

required

Hide properties

alpha2

string

required

Country code (in ISO 3166-1 alpha-2 format).

name

string

required

The Country name.

code

string

required

Country dialing code.

numeric

string

required

Country numeric code.

emoji

string

required

Country flag emoji.

continent

string

required

Continent where the country is located.

languageCode

string

required

Country language code (in ISO 639-1 format).

languageNative

string

required

Country native language name.

custom_rules_applied

object

The custom rules applied to this request, learn more.

Hide properties

total

integer

required

The total number of custom rules applied to this request.

rules

object

required

The custom rules applied to this request, learn more.

Hide properties

string

required

The rule ID as shown in the dashboard (e.g: CR104).

title

string

required

The rule title you set when creating the rule.

status

string

required

Response status (success, or error).

executionTime

integer

required

Time taken to process the data (in milliseconds).

curl --request GET \
  --url https://greipapi.com/lookup/bin \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "reason": "",
    "isValid": true,
    "blacklisted": false,
    "bin": "456789",
    "info": {
      "scheme": {
        "name": "Visa",
        "coName": "Mada",
        "isLuha": true,
        "isPrepaid": false,
        "isCommercial": false,
        "type": "debit",
        "brand": "Traditional",
        "currency": "SAR"
      },
      "detected_digits": "4",
      "syntax": {
        "gaps": [4, 8, 12],
        "lengths": [16, 18, 19],
        "code": {
          "name": "CVV",
          "size": 3
        }
      },
      "bank": {
        "id": "588847",
        "identifier": "80",
        "name": "AL RAJHI BANKING AND INVESTMENT CORP.",
        "city": "Riyadh",
        "url": "https://www.alrajhibank.com.sa",
        "phone": "+96611211600",
        "logo": "https://greip.io/img/banks/al-rajhi.jpg",
        "latitude": "25",
        "longitude": "45"
      },
      "country": {
        "alpha2": "SA",
        "name": "Saudi Arabia",
        "code": "966",
        "numeric": "682",
        "emoji": "🇸🇦",
        "continent": "Asia",
        "languageCode": "ar",
        "languageNative": "العربية"
      }
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "status": "success",
  "executionTime": 2
}

GET

lookup

bin

curl --request GET \
  --url https://greipapi.com/lookup/bin \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "reason": "",
    "isValid": true,
    "blacklisted": false,
    "bin": "456789",
    "info": {
      "scheme": {
        "name": "Visa",
        "coName": "Mada",
        "isLuha": true,
        "isPrepaid": false,
        "isCommercial": false,
        "type": "debit",
        "brand": "Traditional",
        "currency": "SAR"
      },
      "detected_digits": "4",
      "syntax": {
        "gaps": [4, 8, 12],
        "lengths": [16, 18, 19],
        "code": {
          "name": "CVV",
          "size": 3
        }
      },
      "bank": {
        "id": "588847",
        "identifier": "80",
        "name": "AL RAJHI BANKING AND INVESTMENT CORP.",
        "city": "Riyadh",
        "url": "https://www.alrajhibank.com.sa",
        "phone": "+96611211600",
        "logo": "https://greip.io/img/banks/al-rajhi.jpg",
        "latitude": "25",
        "longitude": "45"
      },
      "country": {
        "alpha2": "SA",
        "name": "Saudi Arabia",
        "code": "966",
        "numeric": "682",
        "emoji": "🇸🇦",
        "continent": "Asia",
        "languageCode": "ar",
        "languageNative": "العربية"
      }
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "status": "success",
  "executionTime": 2
}

Overview

Query Parameters

bin

string

required

The BIN/IIN of the card (min: 6 digits).

Sample value: 456789, 456789XXXXXX1234, or 4567891234567890.

format

string

default:"JSON"

The format command is used to get a response in a specific format.

Expected values: JSON, XML, CSV, or Newline

For more information please refer to Response Format.

mode

string

default:"live"

The mode command is used to in the development stage to simulate the integration process before releasing it to the production environment.

Expected values: live, or test.

For more information please refer to Development Environment.

userID

string

The userID command can be used to identify requests sent by specific users to monitor in the Events Page.

Expected values: email address, phone number, user id, name, etc.

For more information please refer to User Identifier.

callback

string

The callback command can help you make the response as a JSONP format.

Expected values: any name that can be used as a function name in Javascript, e.g: myFunctionName.

For more information please refer to JSONP Callback.

{
  "data": {
    "reason": "",
    "isValid": true,
    "blacklisted": false,
    "bin": "456789",
    "info": {
      "scheme": {
        "name": "Visa",
        "coName": "Mada",
        "isLuha": true,
        "isPrepaid": false,
        "isCommercial": false,
        "type": "debit",
        "brand": "Traditional",
        "currency": "SAR"
      },
      "detected_digits": "4",
      "syntax": {
        "gaps": [4, 8, 12],
        "lengths": [16, 18, 19],
        "code": {
          "name": "CVV",
          "size": 3
        }
      },
      "bank": {
        "id": "588847",
        "identifier": "80",
        "name": "AL RAJHI BANKING AND INVESTMENT CORP.",
        "city": "Riyadh",
        "url": "https://www.alrajhibank.com.sa",
        "phone": "+96611211600",
        "logo": "https://greip.io/img/banks/al-rajhi.jpg",
        "latitude": "25",
        "longitude": "45"
      },
      "country": {
        "alpha2": "SA",
        "name": "Saudi Arabia",
        "code": "966",
        "numeric": "682",
        "emoji": "🇸🇦",
        "continent": "Asia",
        "languageCode": "ar",
        "languageNative": "العربية"
      }
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "status": "success",
  "executionTime": 2
}

Response properties

data

object

required

Hide properties

reason

string

required

Reason for the validation result.

isValid

boolean

required

Validation result (true or false).

blacklisted

boolean

required

Indicates if the BIN is blacklisted due to applying custom rules or were found in one of your blacklists.

bin

string

required

The BIN/IIN of the card you passed in the request.

info

object

required

Hide properties

scheme

object

required

Hide properties

name

object

required

Card scheme name.

coName

object

required

Card company name.

isLuha

boolean

required

Is the card issued by Luha?

isPrepaid

boolean

required

Is the card prepaid?

isCommercial

boolean

required

Is the card commercial?

type

string

required

Card type (debit, or credit).

brand

string

required

Card brand (Traditional, Gold, Platinum, etc.).

currency

string

required

Card currency.

detected_digits

string

required

The digits used to detect the scheme details.

syntax

object

required

Hide properties

gaps

array

required

The gaps variations of the card number.

lengths

array

required

The possible lengths of the card number.

code

object

required

Hide properties

name

string

required

The name of the code (e.g: CVV).

size

integer

required

The number of digits in the code.

bank

object

required

Hide properties

string

required

Bank ID.

identifier

string

required

Bank identifier.

name

string

required

The official bank name.

city

string

required

The city where the bank’s headquarters are located.

url

string

required

Bank URL of the official website.

phone

string

required

Bank phone number for contact.

logo

string

required

Bank logo URL (image).

latitude

string

required

Bank latitude coordinates of the country where the bank is located.

longitude

string

required

Bank longitude coordinates of the country where the bank is located.

country

object

required

Hide properties

alpha2

string

required

Country code (in ISO 3166-1 alpha-2 format).

name

string

required

The Country name.

code

string

required

Country dialing code.

numeric

string

required

Country numeric code.

emoji

string

required

Country flag emoji.

continent

string

required

Continent where the country is located.

languageCode

string

required

Country language code (in ISO 639-1 format).

languageNative

string

required

Country native language name.

custom_rules_applied

object

The custom rules applied to this request, learn more.

Hide properties

total

integer

required

The total number of custom rules applied to this request.

rules

object

required

The custom rules applied to this request, learn more.

Hide properties

string

required

The rule ID as shown in the dashboard (e.g: CR104).

title

string

required

The rule title you set when creating the rule.

status

string

required

Response status (success, or error).

executionTime

integer

required

Time taken to process the data (in milliseconds).

curl --request GET \
  --url https://greipapi.com/lookup/bin \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "reason": "",
    "isValid": true,
    "blacklisted": false,
    "bin": "456789",
    "info": {
      "scheme": {
        "name": "Visa",
        "coName": "Mada",
        "isLuha": true,
        "isPrepaid": false,
        "isCommercial": false,
        "type": "debit",
        "brand": "Traditional",
        "currency": "SAR"
      },
      "detected_digits": "4",
      "syntax": {
        "gaps": [4, 8, 12],
        "lengths": [16, 18, 19],
        "code": {
          "name": "CVV",
          "size": 3
        }
      },
      "bank": {
        "id": "588847",
        "identifier": "80",
        "name": "AL RAJHI BANKING AND INVESTMENT CORP.",
        "city": "Riyadh",
        "url": "https://www.alrajhibank.com.sa",
        "phone": "+96611211600",
        "logo": "https://greip.io/img/banks/al-rajhi.jpg",
        "latitude": "25",
        "longitude": "45"
      },
      "country": {
        "alpha2": "SA",
        "name": "Saudi Arabia",
        "code": "966",
        "numeric": "682",
        "emoji": "🇸🇦",
        "continent": "Asia",
        "languageCode": "ar",
        "languageNative": "العربية"
      }
    },
    "custom_rules_applied": {
      "total": 0,
      "rules": []
    }
  },
  "status": "success",
  "executionTime": 2
}

​Overview

​Query Parameters

​Response properties

Packages & Libraries

​Overview

​Query Parameters

​Response properties

Overview

Query Parameters

Response properties

Overview

Query Parameters

Response properties