---
updatedAt: 2024-10-30T15:16:02.000Z
agentTools:
projectIndex: https://docs.authenticate.com/llms.txt
---
# Mock Education Verification Request (Deprecated)
This mimics the Education Verification Request.
There are two possible scenarios which are covered in the mock APIs with userAccessCodes `100385a1-4308-49db-889f-9a898fa88c21` and `9cg686b3-ccb3-497c-a298-3830ea8a1c96`.
**Notes:-** This API is now deprecated. Please refer to the latest version (Version 2) for updated functionalities and improvements. The support for Version 1 APIs will be discontinued after `June 15th, 2024`.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://api-v3.authenticating.com",
"description": "Production server"
}
],
"info": {
"version": "1.0.0",
"title": "Authenticating",
"x-logo": {
"url": "assets/logo.png",
"altText": "Authenticating logo"
}
},
"paths": {
"/mock/education/verify": {
"post": {
"tags": [
"Mock APIs"
],
"summary": "Mock Education Verification Request (Deprecated)",
"description": "This mimics the Education Verification Request.
There are two possible scenarios which are covered in the mock APIs with userAccessCodes `100385a1-4308-49db-889f-9a898fa88c21` and `9cg686b3-ccb3-497c-a298-3830ea8a1c96`.\n\n**Notes:-** This API is now deprecated. Please refer to the latest version (Version 2) for updated functionalities and improvements. The support for Version 1 APIs will be discontinued after `June 15th, 2024`.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"userAccessCode",
"educationList"
],
"type": "object",
"properties": {
"userAccessCode": {
"type": "string",
"format": "UUID"
},
"educationList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"schoolName": {
"type": "string"
},
"schoolType": {
"type": "string"
},
"institutionCampusName": {
"type": "string"
},
"institutionPhone": {
"type": "string"
},
"institutionAddress": {
"type": "string"
},
"institutionAddressTown": {
"type": "string"
},
"institutionAddressCountry": {
"type": "string"
},
"institutionAddressStateProvince": {
"type": "boolean"
},
"institutionAddressPostalCode": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "DD-MM-YYYY"
},
"endDate": {
"type": "string",
"format": "DD-MM-YYYY"
},
"degreeTitle": {
"type": "string"
},
"currentlyAttending": {
"type": "string"
},
"completedSuccessfully": {
"type": "string"
},
"majors": {
"type": "array",
"items": {
"type": "string"
}
},
"minors": {
"type": "array",
"items": {
"type": "string"
}
},
"honors": {
"type": "string"
},
"manualVerification": {
"type": "boolean"
},
"uniqueIdentifier": {
"type": "string",
"format": "UUID"
}
}
}
}
},
"example": {
"userAccessCode": "100385a1-4308-49db-889f-9a898fa88c21",
"educationList": [
{
"institution_name": "VS - HOMETOWN UNIVERSITY",
"institution_name_verified": true,
"institution_type": "University",
"institution_campus_name": "",
"institution_phone": "9102901219",
"institution_address": "221B Baker Street",
"institution_address_verified": true,
"institution_town": "London",
"institution_town_verified": true,
"institution_country": "USA",
"institution_country_verified": true,
"institution_postal_code": "21211",
"degree": "Bachelors in Engineering",
"degree_verified": true,
"start_date": "2011-07-31",
"start_date_verified": true,
"end_date": "2014-07-31",
"end_date_verified": true,
"majors": "Software Engineering",
"majors_verified": true,
"minors": "Biology",
"minors_verified": true,
"honors": "Magna Cum Laude",
"honors_verified": true,
"currently_attending": 0,
"currently_attending_verified": true,
"completed_successfully": 1,
"completed_successfully_verified": true,
"status": "Completed"
},
{
"institution_name": "VS - HOMETOWN UNIVERSITY",
"institution_name_verified": false,
"institution_type": "University",
"institution_campus_name": null,
"institution_phone": "9102901219",
"institution_address": "221B Baker Street",
"institution_address_verified": false,
"institution_town": "London",
"institution_town_verified": false,
"institution_country": "USA",
"institution_country_verified": false,
"institution_postal_code": "21211",
"degree": "Masters in Computer Engineering",
"degree_verified": false,
"start_date": "2015-07-31",
"start_date_verified": false,
"end_date": "2017-07-31",
"end_date_verified": false,
"majors": "Computer Design",
"majors_verified": false,
"minors": "Data Analytics",
"minors_verified": false,
"honors": "Magna Cum Laude",
"honors_verified": false,
"currently_attending": 0,
"currently_attending_verified": false,
"completed_successfully": 1,
"completed_successfully_verified": false,
"status": "Pending"
}
]
},
"x-readme-ref-name": "educationVerificationRequest"
}
}
}
},
"responses": {
"200": {
"description": "success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"institution_name": {
"type": "string"
},
"institution_name_verified": {
"type": "boolean"
},
"institution_type": {
"type": "string"
},
"institution_campus_name": {
"type": "string"
},
"institution_phone": {
"type": "string"
},
"institution_address": {
"type": "string"
},
"institution_address_verified": {
"type": "boolean"
},
"institution_town": {
"type": "boolean"
},
"institution_town_verified": {
"type": "boolean"
},
"institution_country": {
"type": "string"
},
"institution_country_verified": {
"type": "boolean"
},
"institution_postal_code": {
"type": "string"
},
"degree": {
"type": "string"
},
"degree_verified": {
"type": "boolean"
},
"start_date": {
"type": "string",
"format": "YYYY-DD-MM"
},
"start_date_verified": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "YYYY-DD-MM"
},
"end_date_verified": {
"type": "boolean"
},
"majors": {
"type": "string"
},
"majors_verified": {
"type": "boolean"
},
"minors": {
"type": "string"
},
"minors_verified": {
"type": "boolean"
},
"honors": {
"type": "string"
},
"honors_verified": {
"type": "boolean"
},
"currently_attending": {
"type": "integer"
},
"currently_attending_verified": {
"type": "boolean"
},
"completed_successfully": {
"type": "string"
},
"completed_successfully_verified": {
"type": "boolean"
},
"status": {
"type": "integer"
}
}
},
"example": [
{
"institution_name": "VS - HOMETOWN UNIVERSITY",
"institution_name_verified": true,
"institution_type": "University",
"institution_campus_name": "",
"institution_phone": "9102901219",
"institution_address": "221B Baker Street",
"institution_address_verified": true,
"institution_town": "London",
"institution_town_verified": true,
"institution_country": "USA",
"institution_country_verified": true,
"institution_postal_code": "21211",
"degree": "Bachelors in Engineering",
"degree_verified": true,
"start_date": "2011-07-31",
"start_date_verified": true,
"end_date": "2014-07-31",
"end_date_verified": true,
"majors": "Software Engineering",
"majors_verified": true,
"minors": "Biology",
"minors_verified": true,
"honors": "Magna Cum Laude",
"honors_verified": true,
"currently_attending": 0,
"currently_attending_verified": true,
"completed_successfully": 1,
"completed_successfully_verified": true,
"status": "Completed"
}
],
"x-readme-ref-name": "educationVerificationRequestResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string"
}
},
"x-readme-ref-name": "badResponse"
}
}
}
}
}
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```