Group Affiliation Verification

Getting Started

To get started with an integration you’ll need to do the following.

  • Sign up for an ID.me developer account.
  • Register one organization for your company.
  • Register an application for each website property that will need access to Group Affiliation Verification data.
  • Contact partnersupport@id.me to enable the appropriate policies assoicaited with verification and set up UAT/sandbox integrations.
  • Place our ‘Verify with ID.me’ button on your site to allow users to begin authentication and verification.
  • Once users complete verification at ID.me, the partner sends a request to ID.me’s API to retrieve user attributes.

By default, your application will be set up for OAuth. Upon registration, you will immediately have access to the application details page which will list the client_id and client_secret for your OAuth client.


Leveraging the ID.me IDP SAML service will vary depending on the product that is used to implement the federation relationship. Currently, we do not support creating SAML SP profiles automatically through the portal, please contact partnersupport@id.me for assistance in the process.


API Reference

/military/documents

Verification Status

get

https://services.id.me https://services.idmelabs.com /military/documents
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
[
  {
    "name": "DD214",
    "code": "bdf3300a-a5e1-4f96-9700-461982e2f440"
  },
  {
    "name": "Leave Earnings Statement",
    "code": "efbe9497-0230-48c4-ba44-c023939f9291"
  }
]
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/military/verify/person

Verify with personal information

post

https://services.id.me https://services.idmelabs.com /military/verify/person
Parameters
Name In Description Required Schema
fname query users first name true string
lname query users last name true string
social query users full social true string
birth_date query users birth date, yyyy-mm-dd formatted true string
duty_date query users active duty date (any date from their service range), yyyy-mm-dd formatted true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/military/verify/upload

Verify with military document

post

https://services.id.me https://services.idmelabs.com /military/verify/upload
Parameters
Name In Description Required Schema
fname query first name true string
lname query last name true string
social query social security number true string
birth_date query users birth date, yyyy-mm-dd formatted true string
address query users permanent address, fully qualified with street, city, state and zip true string
status query users military status, accepted values [service_member, veteran, retiree] true string
document_file query users military document true string
document_type query users military document type (code from document types endpoint) true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/military/status/{reference_id}

Verification Status

get

https://services.id.me https://services.idmelabs.com /military/status/{reference_id}
Parameters
Name In Description Required Schema
reference_id path reference ID for a previously submitted verification request true string
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 200,
    "message": "Transaction successfully completed",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": true,
    "attributes": {
      "rank": "Captain",
      "branch": "Army",
      "status": "Veteran",
      "service_start_date": "2015-01-01T10:00:00Z",
      "service_stop_date": "2019-01-01T10:00:00Z"
    }
  }
}
Schemas
Response Status 200
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 200,
    "message": "Transaction successfully completed",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": true
  }
}
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 220
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 220,
    "message": "Transaction rejected after review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "code": "MIL0202",
      "text": "Unable to verify military status."
    }
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/responder/documents

Verification Status

get

https://services.id.me https://services.idmelabs.com /responder/documents
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
[
  {
    "name": "Leave Earnings Statement",
    "code": "efbe9497-0230-48c4-ba44-c023939f9291"
  }
]
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/responder/emt/verify/person

Verify with personal information

post

https://services.id.me https://services.idmelabs.com /responder/emt/verify/person
Parameters
Name In Description Required Schema
fname query users first name true string
lname query users last name true string
social query users last 4 of social true string
birth_date query users birth date, yyyy-mm-dd formatted true string
emt_number query users emt number true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/responder/firefighter/verify/person

Verify with personal information

post

https://services.id.me https://services.idmelabs.com /responder/firefighter/verify/person
Parameters
Name In Description Required Schema
fname query users first name true string
lname query users last name true string
social query users full social true string
address query users permanent address, fully qualified with street, city, state and zip true string
state query users state of certification true string
birth_date query users birth date, yyyy-mm-dd formatted true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/responder/emt/verify/upload

Verify with emt document

post

https://services.id.me https://services.idmelabs.com /responder/emt/verify/upload
Parameters
Name In Description Required Schema
fname query first name true string
lname query last name true string
social query social security number (if required) false string
birth_date query users birth date, yyyy-mm-dd formatted true string
address query users permanent address, fully qualified with street, city, state and zip true string
document_file query users military document true string
document_type query users military document type (code from document types endpoint) true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/responder/firefighter/verify/upload

Verify with firefighter document

post

https://services.id.me https://services.idmelabs.com /responder/firefighter/verify/upload
Parameters
Name In Description Required Schema
fname query first name true string
lname query last name true string
social query social security number (if required) false string
birth_date query users birth date, yyyy-mm-dd formatted true string
address query users permanent address, fully qualified with street, city, state and zip true string
document_file query users military document true string
document_type query users military document type (code from document types endpoint) true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/responder/police/verify/upload

Verify with police officer document

post

https://services.id.me https://services.idmelabs.com /responder/police/verify/upload
Parameters
Name In Description Required Schema
fname query first name true string
lname query last name true string
social query social security number (if required) false string
birth_date query users birth date, yyyy-mm-dd formatted true string
address query users permanent address, fully qualified with street, city, state and zip true string
document_file query users military document true string
document_type query users military document type (code from document types endpoint) true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/responder/dispatcher/verify/upload

Verify with 911 dispatcher document

post

https://services.id.me https://services.idmelabs.com /responder/dispatcher/verify/upload
Parameters
Name In Description Required Schema
fname query first name true string
lname query last name true string
social query social security number (if required) false string
birth_date query users birth date, yyyy-mm-dd formatted true string
address query users permanent address, fully qualified with street, city, state and zip true string
document_file query users military document true string
document_type query users military document type (code from document types endpoint) true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/responder/status/{reference_id}

Verification Status

get

https://services.id.me https://services.idmelabs.com /responder/status/{reference_id}
Parameters
Name In Description Required Schema
reference_id path reference ID for a previously submitted verification request true string
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 200,
    "message": "Transaction successfully completed",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": true
  }
}
Schemas
Response Status 200
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 200,
    "message": "Transaction successfully completed",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": true
  }
}
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 220
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 220,
    "message": "Transaction rejected after review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "code": "MIL0202",
      "text": "Unable to verify military status."
    }
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/teacher/states

Returns a list of states and metadata for each state regarding which attributes are required to verify.

get

https://services.id.me https://services.idmelabs.com /teacher/states
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
[
  {
    "code": "VA",
    "name": "Virginia",
    "require_number": false,
    "require_social": false
  },
  {
    "name": "MD",
    "uuid": "Maryland",
    "require_number": true,
    "require_social": false
  },
  {
    "name": "NC",
    "uuid": "North Carolina",
    "require_number": true,
    "require_social": true
  }
]
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/teacher/verify/person

Verify with state certification information

post

https://services.id.me https://services.idmelabs.com /teacher/verify/person
Parameters
Name In Description Required Schema
email query email address true string
fname query first name true string
mname query middle name false string
lname query last name true string
suffix query name suffix true string
birth_date query birth date, yyyy-mm-dd formatted true string
social query users full social true string
address query users permanent address, fully qualified with street, city, state and zip true string
teacher_number query teacher number (if required) false string
school_city query teacher school city true string
school_district query teacher school district true string
school_name query teacher school name true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/teacher/verify/upload

Verify with teacher document

post

https://services.id.me https://services.idmelabs.com /teacher/verify/upload
Parameters
Name In Description Required Schema
email query email address true string
fname query first name true string
mname query middle name false string
lname query last name true string
suffix query name suffix true string
birth_date query birth date, yyyy-mm-dd formatted true string
social query social security number (if required) false string
teacher_number query teacher number (if required) false string
school_city query teacher school city true string
school_district query teacher school district true string
school_name query teacher school name true string
document_file query teacher document for verification true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/teacher/status/{reference_id}

Verification Status

get

https://services.id.me https://services.idmelabs.com /teacher/status/{reference_id}
Parameters
Name In Description Required Schema
reference_id path reference ID for a previously submitted verification request true string
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 200,
    "message": "Transaction successfully completed",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": true
  }
}
Schemas
Response Status 200
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 200,
    "message": "Transaction successfully completed",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": true
  }
}
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 220
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 220,
    "message": "Transaction rejected after review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "code": "MIL0202",
      "text": "Unable to verify military status."
    }
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/student/schools

Returns a list of states and metadata for each state regarding which attributes are required to verify.

get

https://services.id.me https://services.idmelabs.com /student/schools
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
[
  {
    "name": "George Washington University",
    "uuid": "51c0806b-ecc6-4508-b472-3961362507a9",
    "options": [
      "upload",
      "person"
    ]
  },
  {
    "name": "Virginia Tech",
    "uuid": "84e746ad-6120-42dd-957c-db079d76f266",
    "options": [
      "person"
    ]
  }
]
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/student/documents

Returns a list of states and metadata for each state regarding which attributes are required to verify.

get

https://services.id.me https://services.idmelabs.com /student/documents
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
[
  {
    "name": "Current Transcript/Schedule",
    "uuid": "bdf3300a-a5e1-4f96-9700-461982e2f440"
  },
  {
    "name": "Student ID",
    "uuid": "efbe9497-0230-48c4-ba44-c023939f9291"
  }
]
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/student/verify/person

Verify with name and email

post

https://services.id.me https://services.idmelabs.com /student/verify/person
Parameters
Name In Description Required Schema
fname query students first name true string
lname query students last name true string
school query students school (uuid from schools endpoint) true string
social query students last 4 of social false string
birth_date query students birth date, yyyy-mm-dd formatted true string
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/student/verify/upload

Verify with teacher document

post

https://services.id.me https://services.idmelabs.com /student/verify/upload
Parameters
Name In Description Required Schema
fname query first name true string
lname query last name true string
social query social security number (if required) false string
address query students permanent address, fully qualified with street, city, state and zip true string
school query students school (uuid from schools endpoint) true string
birth_date query students birth date, yyyy-mm-dd formatted true string
document_file query students enrollment document true string
document_type query students enrollment document type (uuid from document types endpoint) true string
Responses
HTTP Status 200 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Schemas
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
Response Status 310
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction failed validation",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": {
      "message": "can't be blank",
      "failure": "blank"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors

/student/status/{reference_id}

Verification Status

get

https://services.id.me https://services.idmelabs.com /student/status/{reference_id}
Parameters
Name In Description Required Schema
reference_id path reference ID for a previously submitted verification request true string
Responses
HTTP Status 200 - Transaction successfully completed
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 200,
    "message": "Transaction successfully completed",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": true,
    "attributes": {
      "status": "F",
      "graduation": "2018-01-01T10:00:00Z"
    }
  }
}
Schemas
Response Status 200
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 200,
    "message": "Transaction successfully completed",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": true
  }
}
Response Status 210
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 210,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  }
}
Response Status 220
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 220,
    "message": "Transaction rejected after review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "code": "MIL0202",
      "text": "Unable to verify military status."
    }
  }
}
Response Status 300
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 300,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": {
      "text": "Something went wrong"
    }
  }
}
HTTP Status 401 - Invalid authentication credentials
HTTP Status 403 - Credentials do not have access to given resource
HTTP Status 404 - Accessed resource does not exist
HTTP Status 429 - Rate limit exceeded
HTTP Status 500 - Internal service errors
Waves