> ## Documentation Index > Fetch the complete documentation index at: https://docs.greip.io/llms.txt > Use this file to discover all available pages before exploring further. # BIN / IIN Lookup > Utilize this module to effortlessly retrieve comprehensive information associated with a debit or credit card. The API provides details such as card type (debit or credit), scheme (Visa, Mastercard, etc.), brand (gold, platinum, etc.), and bank information. This data is invaluable for various applications, including verifying customer payment details, detecting fraudulent transactions, and delivering personalized services to enhance user experiences. export const MCPCallout = () => { return
Want to skip the docs? Use the{" "} MCP Server
; }; export const Availability = ({plan, color}) => { const colorMap = { green: "text-green-700 dark:text-green-400", blue: "text-blue-700 dark:text-blue-400", purple: "text-purple-700 dark:text-purple-400" }; return
Endpoint availability:{" "} {plan} Learn more
; }; ## Authentication Include your API key in the `Authorization` header: ```http theme={null} Authorization: Bearer ``` API v2 accepts the key only in this header, not in query parameters or request bodies. See [Authentication](/authentication). ### Path parameters The BIN/IIN of the card (min: 6 digits). Sample value: `456789`, `456789XXXXXX1234`, or `4567891234567890`. ### Query parameters 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](/options/response-format). The mode command is used 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](/options/development-environment). Optional label for your own analytics or support correlation (for example a product or channel name). The user\_id command can be used to identify requests sent by specific users to monitor in the [Events page](/knowledge-base/events-and-alerts/overview). Expected values: email address, phone number, user id, name, etc. For more information please refer to [User identifier](/options/user-identifier). ```json Success theme={null} { "success": true, "data": { "bin": "456789", "is_valid": true, "reason": null, "is_blacklisted": false, "scheme": { "name": "Visa", "is_luhn": true, "is_prepaid": false, "is_commercial": 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", "name": "AL RAJHI BANKING AND INVESTMENT CORP.", "city": "Riyadh", "url": "https://www.alrajhibank.com.sa", "phone": "+96611211600", "latitude": "25", "longitude": "45" }, "country": { "alpha2": "SA", "name": "Saudi Arabia", "code": "966", "numeric": "682", "emoji": "🇸🇦", "continent": "Asia", "language_code": "ar", "language_native": "العربية" } }, "execution_ms": 2 } ``` ```json Error theme={null} { "success": false, "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } ``` ### Response properties `true` when the request succeeded; `false` on error. The BIN/IIN digits from the request (up to 8 digits). Whether the card number prefix passes structural validation. Use `is_blacklisted` for blocklist outcomes. Human-readable validation message when `is_valid` is `false`, or `null` on success. Indicates if the BIN is on your blocklists or matched custom rules (Premium plans and above). Card scheme details when a known issuer is detected; `null` when the scheme is unknown. Card scheme name (for example `Visa`, `Mastercard`). Whether Luhn checksum validation applies to this scheme. Whether the card is prepaid when known; otherwise `null`. Whether the card is commercial when known; otherwise `null`. Card type (`debit`, `credit`, etc.) when known. Card brand when known. Card currency when known. Issuer prefix digits used to detect the scheme. Card number formatting rules for the detected scheme. Gap positions when grouping the card number. Allowed card number lengths. Security code metadata (for example CVV). Code name (for example `CVC`, `CVV`). Number of digits in the code. Issuing bank details when available. Internal bank ID. Bank identifier code when available. Official bank name. Bank city. Bank website URL. Bank contact phone. Bank logo URL when available. Bank latitude when available. Bank longitude when available. Country associated with the issuing bank. ISO 3166-1 alpha-2 country code. Country name. Country dialing code. Country numeric code. Country flag emoji. Continent name. Primary language code (ISO 639-1). Native language name. Time taken to process the request (milliseconds). ## OpenAPI ````yaml openapi/v2.json GET /lookup/bin/{bin} openapi: 3.0.3 info: title: Greip API v2 (docs playground) version: 2.0.0 servers: - url: https://v2.greipapi.com security: [] paths: /lookup/bin/{bin}: get: summary: BIN lookup operationId: lookupBin parameters: - name: bin in: path required: true schema: type: string - name: format in: query schema: type: string default: JSON - name: mode in: query schema: type: string default: live - name: source in: query schema: type: string - name: user_id in: query schema: type: string responses: '200': description: OK security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.