---
agentTools:
  projectIndex: https://sekuritance.readme.io/llms.txt
---

# Retrieve Card Details by BIN

Retrieve Card Details by BIN

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Sekuritance Vault Service",
    "description": "Vault Service to securely store Card & Personal data",
    "contact": {
      "name": "Sekuritance",
      "url": "https://www.sekuritance.com",
      "email": "info@sekuritance.com"
    },
    "license": {
      "name": "LICENSE",
      "url": "http://www.sekuritance.com/wp-content/uploads/2020/01/SekuritanceSiteLogo-e1578570790466.png"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.sekuritance.com/vault"
    }
  ],
  "tags": [
    {
      "name": "Card Bin Checker",
      "description": "API endpoint to get card details by BIN"
    }
  ],
  "paths": {
    "/v1/cards/bin-checker/{bin}": {
      "get": {
        "tags": [
          "Card Bin Checker"
        ],
        "summary": "Retrieve Card Details by BIN",
        "description": "Retrieve Card Details by BIN",
        "operationId": "retrieveCardDetails",
        "parameters": [
          {
            "name": "bin",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ApiCardBinData"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "*/*": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/ErrorResponseCommonErrorCodes"
                    },
                    {
                      "$ref": "#/components/schemas/ErrorResponseErrorCode"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseCommonErrorCodes"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseCommonErrorCodes"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "*/*": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/ErrorResponseCommonErrorCodes"
                    },
                    {
                      "$ref": "#/components/schemas/ErrorResponseErrorCode"
                    }
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponseCommonErrorCodes": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "enum": [
              "UNREADABLE_REQUEST",
              "UNAUTHORIZED",
              "WRONG_ARGUMENT_FOUND",
              "USER_NOT_FOUND",
              "VALIDATION_EXCEPTION",
              "GENERAL_ERROR"
            ]
          },
          "description": {
            "type": "string"
          }
        }
      },
      "ErrorResponseErrorCode": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string",
            "enum": [
              "VALIDATION_ERROR",
              "INVALID_SIGNATURE",
              "GENERAL_ERROR",
              "VAULT_NAME_ALREADY_EXISTS",
              "VAULT_KEY_ALREADY_USED",
              "VAULT_ID_INVALID",
              "DEFAULT_VAULT_ID_INVALID",
              "RETENTION_DATE_INVALID",
              "PERSON_ENTRY_ID_INVALID",
              "FRAUD_CHECK_ID_INVALID",
              "MERCHANT_ID_INVALID",
              "FRAUD_CHECK_REFERENCE_ID_INVALID",
              "VAULT_ENTRY_ID_INVALID",
              "VAULT_REFERENCE_INVALID",
              "VAULT_ENTRY_RETRIEVAL_CONFLICT"
            ]
          },
          "description": {
            "type": "string"
          }
        }
      },
      "ApiCardBinData": {
        "type": "object",
        "properties": {
          "cardBrand": {
            "type": "string",
            "description": "Card brand",
            "enum": [
              "VISA",
              "MAESTRO",
              "CIRRUS",
              "EBT",
              "EFTPOS",
              "LOCAL_BRAND",
              "CHINA_UNION_PAY",
              "PRIVATE_LABEL",
              "DINERS_CLUB_INTERNATIONAL",
              "VISA_DANKORT",
              "UATP",
              "MASTERCARD"
            ]
          },
          "cardType": {
            "type": "string",
            "description": "Card type"
          },
          "cardCategory": {
            "type": "string",
            "description": "Card category"
          },
          "countryCode": {
            "type": "string"
          },
          "countryName": {
            "type": "string",
            "description": "Issuing country"
          },
          "issuer": {
            "type": "string",
            "description": "Card issuer"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 96,
      "1": 51,
      "2": 69,
      "3": 102,
      "4": 205,
      "5": 57,
      "6": 4,
      "7": 0,
      "8": 70,
      "9": 0,
      "10": 246,
      "11": 176
    }
  }
}
```