Einstein Cloud
MeasureOne offers a secure, API-based platform to power consumer-permissioned data sharing, providing a safe and transparent way for consumers to share data with third-party applications.
The MeasureOne platform acts as a bridge between data sources containing the consumer's personal data and data recipients. Data sources are online systems that house the data to be shared and that are accessible to the consumer. Example data sources are academic institutions, payroll processors, utility providers government systems and others. Data recipients are any third-party that the consumer wishes to share information with, often in return for a product or service that the data recipient is offering. Example recipients are lenders, marketeers, background check companies, employers, recruiters, and others.
The APIs specification for the Einstein Cloud. This page is hosted in HTML format on docs.einstein.consulting.
Protocols & Header Parameters
Unless specified otherwise, the Einstein Cloud API uses POST requests to communicate and HTTP
response codes
to indicate status and errors. Unless explicitly specified, all responses come in standard JSON, and all requests must include a Content-Type of application/json with a valid JSON body.
|
Header Parameters |
Values |
|---|---|
|
Authorization |
bearer |
|
Content-Type |
application/json |
Internal Token Authentication
Einstein Cloud REST Web service authenticates internal API requests using access tokens and is not available to any third party organizations. If you do not include the
access_token
when making a request, Einstein Cloud returns an authentication error.
Generate an Access Token
This API returns the access token required for you to access the Einstein Cloud APIs. Access tokens, by default, have a validity of 6 months from the date of generation. The Authorization header should contain the word
Basic
word followed by a space and a base64-encoded string
username:password.
Authorization: Basic ZGVtbzpwQDU1dzByZA==
External OAuth 2.0 Authentication
Einstein Cloud REST Web service authenticates external or Einstein SDK API requests using OAuth 2.0. To gain access to the Einstein Cloud API, please write to
support@einstein.consulting.
[TODO SETUP HANDSHAKE AND CONFIG INSTRUCTIONS]
Status Codes
2xx Success
A 2xx status code indicates the request was received and processed successfully by the Einstein Cloud.
|
Status code |
Description |
|---|---|
|
200 |
OK - The request is successful |
|
201 |
ACCEPTED - The request is successful and has been accepted for further processing. You will receive a notification once the request has completed. |
4xx Client Errors
A 4xx status code indicates that the request failed due to a client error. The response body generally includes more details about the failure.
|
Status code |
Description |
|---|---|
|
400 |
Bad Request - The request failed. This will usually occur when validations fail. E.g Missing required fields or invalid JSON |
5xx Server Errors
A 5xx status codes is returned if something goes wrong on the Einstein Cloud's end
|
Status code |
Description |
|---|---|
|
500 |
Data Model
The Einstein Cloud Data Model and nested objects or properties.
|
UID |
uuid |
|
|
score |
integer |
The computed Risk score when status = COMPLETED |
|
created |
datetime |
|
|
completed |
datetime |
|
|
tenantID |
uuid |
The lender ID |
|
applicationID |
uuid |
|
|
transcriptID |
uuid |
|
|
school |
string |
|
|
status |
string |
PENDING COMPLETED REFUSED ERROR |
JSON Example:
{
"uid": "string",
"status": "PENDING",
"score": 450,
"created": "2021-12-20 23:02:41.574",
"completed": null,
"tenantID": "string",
"applicationID": "string",
"transcriptID": null,
"school": "Massachusetts Institute Of Technology"
}
StudentTranscript
|
UID |
uuid |
|
|
requested |
|
|
|
obtained |
|
|
|
requestID |
|
|
JSON Example:
{
"uid": "string",
"requestID": "string",
"requested": "2021-12-20 23:02:41.574",
"obtained": "2021-12-20 23:02:41.574",
"transcript": {...} // see below
}
MeasureOne purged nested transcript object (https://docs.measureone.com/#tag/m1_transcript_model ):
{
"transcript_date": string,
"other_attributes": {},
"previous_academic_record": [
{
"name": string,
"id_type": string,
"id": string,
"start_date": string,
"end_date": string,
"address": {
"addr1": string,
"addr2": string,
"city": string,
"state": string,
"zipcode": string,
"country": {
"name": string,
"a2_code": string
}
},
"degrees": [
{
"type": string,
"description": string,
"status": string,
"awarded_date": string,
"years_of_study": 0,
"other_attributes": {},
"academic_summary": [
{
"credit_type": string,
"level": string,
"cumulative": true,
"gpa_credits": 0,
"attempted": 0,
"earned": 0,
"gpa": 0,
"quality_points": 0
}
],
"field_of_study": [
{
"type": string,
"description": string,
"code_type": string,
"code": 0
}
]
}
]
}
],
"transcript_institution": {
"name": string,
"id_type": string,
"id": string,
"address": {
"addr1": string,
"addr2": string,
"city": string,
"state": string,
"zipcode": string,
"country": {
"name": string,
"a2_code": string
}
},
"other_attributes": {}
},
"academic_summary": [
{
"credit_type": string,
"level": string,
"cumulative": true,
"gpa_credits": 0,
"attempted": 0,
"earned": 0,
"gpa": 0,
"quality_points": 0
}
],
"academic_sessions": [
{
"type": string,
"name": string,
"start_date": string,
"end_date": string,
"in_progress": true,
"level": string,
"honors": [string],
"curriculum_code_type": string,
"curriculum_code": string,
"curriculum_name": string,
"academic_summary": [
{
"credit_type": string,
"level": string,
"cumulative": true,
"gpa_credits": 0,
"attempted": 0,
"earned": 0,
"gpa": 0,
"quality_points": 0
}
],
"courses": [
{
"credit_basis": string,
"honors_course": true,
"repeated": true,
"count_in_gpa": true,
"code_type": string,
"code": string,
"id": string,
"name": string,
"instructional_setting": string,
"start_date": string,
"end_date": string,
"other_attributes": {},
"credits": {
"credit_type": string,
"gpa_credits": 0,
"attempted": 0,
"earned": 0,
"quality_points": 0,
"grade_qualifier": string,
"grade": string
}
}
],
"degrees": [
{
"description": string,
"type": string,
"status": string,
"awarded_date": string,
"years_of_study": 0,
"other_attributes": {},
"academic_summary": [
{
"credit_type": string,
"level": string,
"cumulative": true,
"gpa_credits": 0,
"attempted": 0,
"earned": 0,
"gpa": 0,
"quality_points": 0
}
],
"field_of_study": [
{
"type": string,
"description": string,
"code_type": string,
"code": string
}
]
}
],
"other_attributes": {}
}
]
}
Lender
|
UID |
uuid |
The lender/tenant ID |
|
status |
string |
PENDING ACTIVE INACTIVE |
|
name |
string |
|
|
license |
string |
a unique APIs license key |
|
registered |
datetime |
|
|
address |
string |
|
|
city |
string |
|
|
poc |
string |
|
|
country |
string |
|
|
vatCode |
string |
JSON Example:
{
"uid": "string",
"status": "PENDING",
"registered": "2021-12-20 23:02:41.574",
"name": "string",
"address": "string",
"city": "string",
"poc": "string",
"country": "string",
"vatCode": "string"
}
APIAgent
|
UID |
uuid |
|
|
name |
integer |
|
|
created |
datetime |
|
|
license |
string |
a unique APIs multi-tenant license key for SDK |
|
validUntil |
datetime |
|
|
origin |
string |
domain name or IP |
JSON Example:
{
"uid": "string",
"name": "Agent for Anova_1",
"created": "2021-12-20 23:02:41.574",
"license": "abd554f4ea",
"validUntil": "2022-12-20 23:02:41.574",
"origin": "192.168.1.1"
}