# Get card enrollment

Get VFC card enrolled/registered credentials.


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Card issuing - Visa Flexible Credentials [beta]",
    "description": "Visa Flexible Credentials endpoints.",
    "version": "1.0.0",
    "contact": {
      "email": "support@pismo.com.br",
      "name": "API Support",
      "url": "https://developers.pismo.io/support"
    },
    "license": {
      "name": "Copyright Pismo",
      "url": "https://developers.pismo.io/licenses"
    },
    "termsOfService": "https://developers.pismo.io/terms"
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "Sandbox API server for testing"
    }
  ],
  "tags": [
    {
      "name": "Enrollment",
      "description": "Card enrollment and management endpoints."
    }
  ],
  "components": {
    "parameters": {
      "accessTokenHeader": {
        "name": "access_token",
        "in": "header",
        "required": true,
        "schema": {
          "type": "string"
        },
        "description": "Access token. Tokens can expire quickly, which can result in a **401 Unauthorized** error."
      },
      "CardIDpath": {
        "name": "cardId",
        "in": "path",
        "schema": {
          "type": "string"
        },
        "description": "Card ID",
        "required": true
      }
    },
    "schemas": {
      "CardID": {
        "type": "integer",
        "format": "int64",
        "description": "Enrolled card ID",
        "example": 6743052
      },
      "DocumentId": {
        "type": "string",
        "description": "Enrollment document ID. UUID from Visa that identifies card in VFC.",
        "example": "v-301-923113d1-c87e-460f-a504-9eb7999163ff"
      },
      "ErrorObject": {
        "type": "object",
        "description": "Standard error object",
        "properties": {
          "error_code": {
            "type": "string",
            "description": "Error code"
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "EnrollmentResponse": {
        "type": "object",
        "description": "Response object for card enrollment creation",
        "required": [
          "card_id",
          "document_id"
        ],
        "properties": {
          "card_id": {
            "$ref": "#/components/schemas/CardID"
          },
          "document_id": {
            "$ref": "#/components/schemas/DocumentId"
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a \"**401 Unauthorized**\" error.",
        "bearerFormat": "JWT"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorObject"
            },
            "example": {
              "error_code": "ERR9993",
              "message": "card not found"
            }
          }
        }
      },
      "401Unauthorized": {
        "description": "Access token is missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorObject"
            },
            "example": {
              "error_code": "ERR9786",
              "message": "Access token is missing or invalid"
            }
          }
        }
      },
      "500InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorObject"
            },
            "example": {
              "error_code": "ERR5446",
              "message": "Internal server error"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/v1/vfc/enrollment/cards/{cardId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/accessTokenHeader"
        },
        {
          "$ref": "#/components/parameters/CardIDpath"
        }
      ],
      "get": {
        "summary": "Get card enrollment",
        "description": "Get VFC card enrolled/registered credentials.\n",
        "operationId": "get-card-enrollment",
        "tags": [
          "Enrollment"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/accessTokenHeader"
          },
          {
            "$ref": "#/components/parameters/CardIDpath"
          }
        ],
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EnrollmentResponse"
                },
                "example": {
                  "card_id": 186283623,
                  "document_id": "v-301-923113d1-c87e-460f-a504-9eb7999163ff"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  }
}
```