---
updatedAt: 2026-07-02T10:57:17.000Z
agentTools:
  projectIndex: https://developer.2hire.io/llms.txt
---

# Check Ford enrollment status

Check the enrollment status of a Ford vehicle

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "version": "1.0.0",
    "title": "2hireAsAdapter API - Prod",
    "description": "2hireAsAdapter API lets you manage and control one vehicle and a thousand vehicle alike.",
    "contact": {
      "name": "2hire",
      "email": "info@2hire.io",
      "url": "https://2hire.io"
    }
  },
  "servers": [
    {
      "url": "https://adapter.2hire.io"
    }
  ],
  "tags": [
    {
      "name": "Connectivity Provider",
      "description": "Perform action on a specific connectivity provider"
    }
  ],
  "paths": {
    "/api/v1/connectivity-provider/ford/enrollment_status/{vin}": {
      "get": {
        "security": [
          {
            "Bearer": []
          }
        ],
        "tags": [
          "Connectivity Provider"
        ],
        "summary": "Check Ford enrollment status",
        "operationId": "GetEnrollmentStatus",
        "description": "Check the enrollment status of a Ford vehicle",
        "parameters": [
          {
            "name": "vin",
            "in": "path",
            "description": "Identifier of the vehicle",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/SuccessEnrollmentStatusResponse"
          },
          "400": {
            "$ref": "#/components/responses/BadRequestErrorEnrollmentStatus"
          },
          "409": {
            "$ref": "#/components/responses/ConflictErrorEnrollmentStatus"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "responses": {
      "InternalError": {
        "description": "Internal Error Response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/InternalError"
            },
            "examples": {
              "Internal Error": {
                "value": {
                  "code": "INTERNAL_ERROR",
                  "details": {
                    "cause": "INTERNAL_ERROR"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              }
            }
          }
        }
      },
      "BadRequestErrorEnrollmentStatus": {
        "description": "Bad Request Response. A possible cause is that no enrollment exists",
        "content": {
          "application/json": {
            "schema": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/EnrollmentStatusBadRequestError"
                }
              ]
            },
            "examples": {
              "No enrollment exists": {
                "value": {
                  "code": "BAD_REQUEST_ERROR",
                  "details": {
                    "cause": "BAD_REQUEST"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              }
            }
          }
        }
      },
      "ConflictErrorEnrollmentStatus": {
        "description": "Conflict Error Response. A possible cause is that some permissions are missing",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ConflictErrorResourceNotAvailable"
            },
            "examples": {
              "Resource Not Available": {
                "value": {
                  "code": "CONFLICT_ERROR",
                  "details": {
                    "cause": "RESOURCE_NOT_AVAILABLE"
                  },
                  "errorId": "21127d29-1587-4cc7-92c6-d74b98497e56"
                }
              }
            }
          }
        }
      },
      "SuccessEnrollmentStatusResponse": {
        "description": "Current vehicle enrollment status",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "title": "EnrollmentStatus",
              "properties": {
                "status": {
                  "type": "string",
                  "enum": [
                    "ENROLL_COMPLETED",
                    "ENROLL_PENDING",
                    "ACTION_REQUIRED",
                    "ENROLL_FAILED",
                    "UNENROLL_COMPLETED",
                    "UNENROLL_PENDING",
                    "UNENROLL_FAILED"
                  ],
                  "description": "The current status"
                }
              }
            },
            "examples": {
              "Vehicle Enrollment status": {
                "value": {
                  "status": "ENROLL_COMPLETED"
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "InternalErrorCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "INTERNAL_ERROR"
            ]
          }
        }
      },
      "QRCodeNotFoundCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "QR_CODE_NOT_FOUND"
            ]
          }
        }
      },
      "InternalError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "INTERNAL_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "oneOf": [
              {
                "$ref": "#/components/schemas/InternalErrorCause"
              },
              {
                "$ref": "#/components/schemas/QRCodeNotFoundCause"
              }
            ]
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      },
      "BadRequestCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "BAD_REQUEST"
            ]
          }
        }
      },
      "BadFormatCause": {
        "type": "object",
        "properties": {
          "cause": {
            "type": "string",
            "description": "Specific cause of the error",
            "enum": [
              "BAD_FORMAT"
            ]
          }
        }
      },
      "EnrollmentStatusBadRequestError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "BAD_REQUEST_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "oneOf": [
              {
                "$ref": "#/components/schemas/BadFormatCause"
              },
              {
                "$ref": "#/components/schemas/BadRequestCause"
              }
            ]
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      },
      "ConflictErrorResourceNotAvailable": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Code of the error",
            "enum": [
              "CONFLICT_ERROR"
            ]
          },
          "details": {
            "type": "object",
            "properties": {
              "cause": {
                "type": "string",
                "description": "Specific cause of the error",
                "enum": [
                  "RESOURCE_NOT_AVAILABLE"
                ]
              }
            }
          },
          "errorId": {
            "type": "string",
            "description": "uuid generated in order to track logs"
          }
        }
      }
    }
  }
}
```