> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fern-docs.skyflow.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fern-docs.skyflow.dev/_mcp/server.

# Get BIN

POST https://%7B%7Bvault_url_identifier%7D%7D.vault.skyflowapis.com/v1/card_lookup
Content-Type: application/json

Note: This endpoint is in beta and subject to change.  Returns the specified card metadata.

Reference: https://fern-docs.skyflow.dev/api/data/bin-lookup

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://%7B%7Bvault_url_identifier%7D%7D.vault.skyflowapis.com` (Production, default)
- `https://%7B%7Bvault_url_identifier%7D%7D.vault.skyflowapis-preview.com` (Sandbox)

## Request

### Body (application/json)

This endpoint expects a bin_lookup_request.

- `bin_lookup_request`
  - BIN: BIN
  - Skyflow ID: Skyflow ID

## Response

### 200

A successful response.

- `cards_data` (list of BinLookupResponseCardsDataItems, optional) — Card metadata associated with the specified BIN.

## Errors

### 400 Bad Request Error

Returned when the request doesn't match the schema, such as not including required fields.

- `error` (ErrorResponseError, required)

### 401 Unauthorized Error

Returned when the request doesn't match the schema, such as not including required fields.

- `string`

### 404 Not Found Error

Returned when the resource doesn't exist.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

An unexpected error response.

- `error` (ErrorResponseError, required)

## Types

### BIN

Find card metadata by BIN.

- `BIN` (string, required) — BIN of the card, which is the first 4-9 digits of the card number depending on the brand.
- `fields` (list of enum, optional) — Card data to return. `card_expiry` and `card_last_four_digits` need their the associated columns specified in `vault_schema_config` or they won't return values.
  - Allowed values: `card_category`, `card_expiry`, `card_last_four_digits`, `card_scheme`, `card_type`, `country_code`, `currency`, `issuer_name`

### Skyflow ID

Find card metadata by `skyflow_id`.

- `skyflow_id` (string, required) — skyflow\_id of the record that contains the BIN and additional card information. Must be used with `vault_schema_config`.
- `vault_schema_config` (BinLookupRequestOneOf1VaultSchemaConfig, required) — Details of the vault that stores additional card details. Must be used with `skyflow_id`.
- `fields` (list of enum, optional) — Card data to return. `card_expiry` and `card_last_four_digits` need their the associated columns specified in `vault_schema_config` or they won't return values.
  - Allowed values: `card_category`, `card_expiry`, `card_last_four_digits`, `card_scheme`, `card_type`, `country_code`, `currency`, `issuer_name`

### BinLookupResponseCardsDataItems

Card metadata of the requested BIN.

- `BIN` (string, optional) — BIN of the card.
- `issuer_name` (string, optional) — Name of the card issuer bank.
- `country_code` (string, optional) — Country code of the card.
- `currency` (string, optional) — Currency of the card.
- `card_type` (string, optional) — Type of the card.
- `card_category` (string, optional) — Category of the card.
- `card_scheme` (string, optional) — Scheme of the card.
- `card_last_four_digits` (string, optional) — Last four digits of the card number.
- `card_expiry` (string, optional) — Expiry date of the card.

### ErrorResponseError

- `grpc_code` (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
- `http_code` (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
- `http_status` (string, required) — HTTP status message.
- `message` (string, required)
- `details` (list of map from string to any, optional)

### BinLookupRequestOneOf1VaultSchemaConfig

Details of the vault that stores additional card details. Must be used with `skyflow_id`.

- `id` (string, required) — ID of the vault that stores card details.
- `table_name` (string, required) — Name of the table that stores card details.
- `mapping` (BinLookupRequestOneOf1VaultSchemaConfigMapping, required) — Mapping of the fields in the vault to the fields to use for the lookup.

### BinLookupRequestOneOf1VaultSchemaConfigMapping

Mapping of the fields in the vault to the fields to use for the lookup.

- `card_number` (string, optional) — Name of the column that stores the card number.
- `card_last_four_digits` (string, optional) — Name of the column that stores the card number suffix.
- `card_expiry` (string, optional) — Name of the column that stores the expiry date.

## Examples

### BIN

**Request**

```json
{
  "BIN": "455673070"
}
```

**Response**

```json
{
  "cards_data": [
    {
      "BIN": "012345",
      "issuer_name": "JPMorgan Chase Bank N.A.",
      "country_code": "US",
      "currency": "",
      "card_type": "credit",
      "card_category": "Visa Traditional",
      "card_scheme": "Visa"
    }
  ]
}
```

**SDK Code**

```python BIN
import requests

url = "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup"

payload = { "BIN": "455673070" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript BIN
const url = 'https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"BIN":"455673070"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go BIN
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup"

	payload := strings.NewReader("{\n  \"BIN\": \"455673070\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby BIN
require 'uri'
require 'net/http'

url = URI("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"BIN\": \"455673070\"\n}"

response = http.request(request)
puts response.read_body
```

```java BIN
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"BIN\": \"455673070\"\n}")
  .asString();
```

```php BIN
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup', [
  'body' => '{
  "BIN": "455673070"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp BIN
using RestSharp;

var client = new RestClient("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"BIN\": \"455673070\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift BIN
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["BIN": "455673070"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### BIN with fields

**Request**

```json
{
  "BIN": "455673070",
  "fields": [
    "card_type",
    "card_category",
    "card_scheme"
  ]
}
```

**Response**

```json
{
  "cards_data": [
    {
      "BIN": "012345",
      "card_type": "credit",
      "card_category": "Visa Traditional",
      "card_scheme": "Visa"
    }
  ]
}
```

**SDK Code**

```python BIN with fields
import requests

url = "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup"

payload = {
    "BIN": "455673070",
    "fields": ["card_type", "card_category", "card_scheme"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript BIN with fields
const url = 'https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"BIN":"455673070","fields":["card_type","card_category","card_scheme"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go BIN with fields
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup"

	payload := strings.NewReader("{\n  \"BIN\": \"455673070\",\n  \"fields\": [\n    \"card_type\",\n    \"card_category\",\n    \"card_scheme\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby BIN with fields
require 'uri'
require 'net/http'

url = URI("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"BIN\": \"455673070\",\n  \"fields\": [\n    \"card_type\",\n    \"card_category\",\n    \"card_scheme\"\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java BIN with fields
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"BIN\": \"455673070\",\n  \"fields\": [\n    \"card_type\",\n    \"card_category\",\n    \"card_scheme\"\n  ]\n}")
  .asString();
```

```php BIN with fields
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup', [
  'body' => '{
  "BIN": "455673070",
  "fields": [
    "card_type",
    "card_category",
    "card_scheme"
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp BIN with fields
using RestSharp;

var client = new RestClient("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"BIN\": \"455673070\",\n  \"fields\": [\n    \"card_type\",\n    \"card_category\",\n    \"card_scheme\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift BIN with fields
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "BIN": "455673070",
  "fields": ["card_type", "card_category", "card_scheme"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### skyflow_id

**Request**

```json
{
  "skyflow_id": "c8d829fe-a722-47c7-ba01-9a44b27019d4",
  "vault_schema_config": {
    "id": "c35dcf755b60479cae65ae1362e49642",
    "table_name": "credit_cards",
    "mapping": {
      "card_number": "card_number",
      "card_expiry": "expiry_year"
    }
  },
  "fields": [
    "card_expiry"
  ]
}
```

**Response**

```json
{
  "cards_data": [
    {
      "BIN": "012345",
      "card_expiry": "0624"
    }
  ]
}
```

**SDK Code**

```python skyflow_id
import requests

url = "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup"

payload = {
    "skyflow_id": "c8d829fe-a722-47c7-ba01-9a44b27019d4",
    "vault_schema_config": {
        "id": "c35dcf755b60479cae65ae1362e49642",
        "table_name": "credit_cards",
        "mapping": {
            "card_number": "card_number",
            "card_expiry": "expiry_year"
        }
    },
    "fields": ["card_expiry"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript skyflow_id
const url = 'https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"skyflow_id":"c8d829fe-a722-47c7-ba01-9a44b27019d4","vault_schema_config":{"id":"c35dcf755b60479cae65ae1362e49642","table_name":"credit_cards","mapping":{"card_number":"card_number","card_expiry":"expiry_year"}},"fields":["card_expiry"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go skyflow_id
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup"

	payload := strings.NewReader("{\n  \"skyflow_id\": \"c8d829fe-a722-47c7-ba01-9a44b27019d4\",\n  \"vault_schema_config\": {\n    \"id\": \"c35dcf755b60479cae65ae1362e49642\",\n    \"table_name\": \"credit_cards\",\n    \"mapping\": {\n      \"card_number\": \"card_number\",\n      \"card_expiry\": \"expiry_year\"\n    }\n  },\n  \"fields\": [\n    \"card_expiry\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby skyflow_id
require 'uri'
require 'net/http'

url = URI("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"skyflow_id\": \"c8d829fe-a722-47c7-ba01-9a44b27019d4\",\n  \"vault_schema_config\": {\n    \"id\": \"c35dcf755b60479cae65ae1362e49642\",\n    \"table_name\": \"credit_cards\",\n    \"mapping\": {\n      \"card_number\": \"card_number\",\n      \"card_expiry\": \"expiry_year\"\n    }\n  },\n  \"fields\": [\n    \"card_expiry\"\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java skyflow_id
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"skyflow_id\": \"c8d829fe-a722-47c7-ba01-9a44b27019d4\",\n  \"vault_schema_config\": {\n    \"id\": \"c35dcf755b60479cae65ae1362e49642\",\n    \"table_name\": \"credit_cards\",\n    \"mapping\": {\n      \"card_number\": \"card_number\",\n      \"card_expiry\": \"expiry_year\"\n    }\n  },\n  \"fields\": [\n    \"card_expiry\"\n  ]\n}")
  .asString();
```

```php skyflow_id
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup', [
  'body' => '{
  "skyflow_id": "c8d829fe-a722-47c7-ba01-9a44b27019d4",
  "vault_schema_config": {
    "id": "c35dcf755b60479cae65ae1362e49642",
    "table_name": "credit_cards",
    "mapping": {
      "card_number": "card_number",
      "card_expiry": "expiry_year"
    }
  },
  "fields": [
    "card_expiry"
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp skyflow_id
using RestSharp;

var client = new RestClient("https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"skyflow_id\": \"c8d829fe-a722-47c7-ba01-9a44b27019d4\",\n  \"vault_schema_config\": {\n    \"id\": \"c35dcf755b60479cae65ae1362e49642\",\n    \"table_name\": \"credit_cards\",\n    \"mapping\": {\n      \"card_number\": \"card_number\",\n      \"card_expiry\": \"expiry_year\"\n    }\n  },\n  \"fields\": [\n    \"card_expiry\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift skyflow_id
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "skyflow_id": "c8d829fe-a722-47c7-ba01-9a44b27019d4",
  "vault_schema_config": [
    "id": "c35dcf755b60479cae65ae1362e49642",
    "table_name": "credit_cards",
    "mapping": [
      "card_number": "card_number",
      "card_expiry": "expiry_year"
    ]
  ],
  "fields": ["card_expiry"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{{vault_url_identifier}}.vault.skyflowapis.com/v1/card_lookup")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```