SCRA Monitoring

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 SCRA Monitoring 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

Choose Enviorment: Production Sandbox

Description: Verification API

Version: 1.0

teacherStates

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
Parameters
Name In Description Required Schema
client_id query The client identifier received during app registration. It is automatically generated and located in your application dashboard. true string
client_secret query A secret identifier received during app registration. It is automatically generated and located in your application dashboard. true string
Responses
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
  }
]
Status: 401 - Invalid authentication credentials
Status: 1100 - Credentials used are not associated with any account
Status: 1200 - Credentials used are associated with an inactive account
Status: 1300 - Credentials used are associated with an inactive organization
Status: 403 - Credentials do not have access to given resource
Status: 2100 - Referenced product cannot be found
Status: 2200 - Referenced product is not active
Status: 2300 - Referenced product is not enabled for this account
Status: 404 - Accessed resource does not exist
Status: 4100 - Resource not found
Status: 422 - Invalid or missing input parameters
Status: 3100 - Transaction not found with the given reference ID
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

teacherVerifyPerson

Verify with state certification information

POST

https://services.id.me https://services.idmelabs.com /teacher/verify/person
Parameters
Name In Description Required Schema
client_id query The client identifier received during app registration. It is automatically generated and located in your application dashboard. true string
client_secret query A secret identifier received during app registration. It is automatically generated and located in your application dashboard. true string
email query email address true string
fname query first name true string
mname query middle name false string
lname query last name true string
state query state the teacher is verified in (2-letter reresentation of the 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
Responses
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,
    "history": {
      "identifier": "8037315c-6997-4c40-87ca-8a835978423b",
      "verifications": 1,
      "verified_last": "2018-01-01T10:00:00Z"
    }
  }
}
Status: 210 - 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"
  }
}
Status: 220 - Transaction rejected after review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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_text": "Document is unreadable",
    "reason_code": "12345"
  }
}
Status: 300 - Transaction unsuccessful
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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",
    "reason_code": "12345"
  }
}
Status: 310 - Validation errors
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": "can't be blank",
    "birth_date": "is not a valid date"
  }
}
Status: 401 - Invalid authentication credentials
Status: 1100 - Credentials used are not associated with any account
Status: 1200 - Credentials used are associated with an inactive account
Status: 1300 - Credentials used are associated with an inactive organization
Status: 403 - Credentials do not have access to given resource
Status: 2100 - Referenced product cannot be found
Status: 2200 - Referenced product is not active
Status: 2300 - Referenced product is not enabled for this account
Status: 404 - Accessed resource does not exist
Status: 4100 - Resource not found
Status: 422 - Invalid or missing input parameters
Status: 3100 - Transaction not found with the given reference ID
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

teacherVerifyUpload

Verify with teacher document

POST

https://services.id.me https://services.idmelabs.com /teacher/verify/upload
Parameters
Name In Description Required Schema
client_id query The client identifier received during app registration. It is automatically generated and located in your application dashboard. true string
client_secret query A secret identifier received during app registration. It is automatically generated and located in your application dashboard. true string
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
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,
    "history": {
      "identifier": "8037315c-6997-4c40-87ca-8a835978423b",
      "verifications": 1,
      "verified_last": "2018-01-01T10:00:00Z"
    }
  }
}
Status: 210 - 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"
  }
}
Status: 220 - Transaction rejected after review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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_text": "Document is unreadable",
    "reason_code": "12345"
  }
}
Status: 300 - Transaction unsuccessful
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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",
    "reason_code": "12345"
  }
}
Status: 310 - Validation errors
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": "can't be blank",
    "birth_date": "is not a valid date"
  }
}
Status: 401 - Invalid authentication credentials
Status: 1100 - Credentials used are not associated with any account
Status: 1200 - Credentials used are associated with an inactive account
Status: 1300 - Credentials used are associated with an inactive organization
Status: 403 - Credentials do not have access to given resource
Status: 2100 - Referenced product cannot be found
Status: 2200 - Referenced product is not active
Status: 2300 - Referenced product is not enabled for this account
Status: 404 - Accessed resource does not exist
Status: 4100 - Resource not found
Status: 422 - Invalid or missing input parameters
Status: 3100 - Transaction not found with the given reference ID
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

teacherStatus{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
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,
    "history": {
      "identifier": "8037315c-6997-4c40-87ca-8a835978423b",
      "verifications": 1,
      "verified_last": "2018-01-01T10:00:00Z"
    }
  }
}
Status: 210 - 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"
  }
}
Status: 220 - Transaction rejected after review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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_text": "Document is unreadable",
    "reason_code": "12345"
  }
}
Status: 300 - Transaction unsuccessful
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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",
    "reason_code": "12345"
  }
}
Status: 310 - Validation errors
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": "can't be blank",
    "birth_date": "is not a valid date"
  }
}
Status: 401 - Invalid authentication credentials
Status: 1100 - Credentials used are not associated with any account
Status: 1200 - Credentials used are associated with an inactive account
Status: 1300 - Credentials used are associated with an inactive organization
Status: 403 - Credentials do not have access to given resource
Status: 2100 - Referenced product cannot be found
Status: 2200 - Referenced product is not active
Status: 2300 - Referenced product is not enabled for this account
Status: 404 - Accessed resource does not exist
Status: 4100 - Resource not found
Status: 422 - Invalid or missing input parameters
Status: 3100 - Transaction not found with the given reference ID
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

studentSchools

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
Parameters
Name In Description Required Schema
client_id query The client identifier received during app registration. It is automatically generated and located in your application dashboard. true string
client_secret query A secret identifier received during app registration. It is automatically generated and located in your application dashboard. true string
Responses
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"
    ]
  }
]
Status: 401 - Invalid authentication credentials
Status: 403 - Credentials do not have access to given resource
Status: 404 - Accessed resource does not exist
Status: 422 - Invalid or missing input parameters
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

studentDocuments

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
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"
  }
]
Status: 401 - Invalid authentication credentials
Status: 403 - Credentials do not have access to given resource
Status: 404 - Accessed resource does not exist
Status: 422 - Invalid or missing input parameters
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

studentVerifyPerson

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
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,
    "history": {
      "identifier": "8037315c-6997-4c40-87ca-8a835978423b",
      "verifications": 1,
      "verified_last": "2018-01-01T10:00:00Z"
    },
    "attributes": {
      "status": "F",
      "graduation": "2018-01-01T10:00:00Z"
    }
  }
}
Status: 401 - Invalid authentication credentials
Status: 403 - Credentials do not have access to given resource
Status: 404 - Accessed resource does not exist
Status: 422 - Invalid or missing input parameters
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

studentVerifyUpload

Verify with teacher document

POST

https://services.id.me https://services.idmelabs.com /student/verify/upload
Parameters
Name In Description Required Schema
client_id query The client identifier received during app registration. It is automatically generated and located in your application dashboard. true string
client_secret query A secret identifier received during app registration. It is automatically generated and located in your application dashboard. true string
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
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,
    "history": {
      "identifier": "8037315c-6997-4c40-87ca-8a835978423b",
      "verifications": 1,
      "verified_last": "2018-01-01T10:00:00Z"
    },
    "attributes": {
      "status": "F",
      "graduation": "2018-01-01T10:00:00Z"
    }
  }
}
Status: 205 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 205,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false
  }
}
Status: 210 - Transaction rejected after review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 205,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": "Document is unreadable"
  }
}
Status: 300 - Transaction unsuccessful
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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",
    "reason_code": "12345"
  }
}
Status: 310 - Validation errors
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": "can't be blank",
    "birth_date": "is not a valid date"
  }
}
Status: 401 - Invalid authentication credentials
Status: 403 - Credentials do not have access to given resource
Status: 404 - Accessed resource does not exist
Status: 422 - Invalid or missing input parameters
Status: 3100 - Transaction not found with the given reference ID
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

studentStatus{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
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,
    "history": {
      "identifier": "8037315c-6997-4c40-87ca-8a835978423b",
      "verifications": 1,
      "verified_last": "2018-01-01T10:00:00Z"
    },
    "attributes": {
      "status": "F",
      "graduation": "2018-01-01T10:00:00Z"
    }
  }
}
Status: 205 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 205,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false
  }
}
Status: 210 - Transaction rejected after review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 205,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": "Document is unreadable"
  }
}
Status: 300 - Transaction unsuccessful
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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",
    "reason_code": "12345"
  }
}
Status: 310 - Validation errors
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": "can't be blank",
    "birth_date": "is not a valid date"
  }
}
Status: 401 - Invalid authentication credentials
Status: 403 - Credentials do not have access to given resource
Status: 404 - Accessed resource does not exist
Status: 422 - Invalid or missing input parameters
Status: 3100 - Transaction not found with the given reference ID
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

militaryDocuments

Verification Status

GET

https://services.id.me https://services.idmelabs.com /military/documents
Parameters
Name In Description Required Schema
client_id query The client identifier received during app registration. It is automatically generated and located in your application dashboard. true string
client_secret query A secret identifier received during app registration. It is automatically generated and located in your application dashboard. true string
Responses
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"
  }
}
Status: 401 - Invalid authentication credentials
Status: 403 - Credentials do not have access to given resource
Status: 404 - Accessed resource does not exist
Status: 422 - Invalid or missing input parameters
Status: 3100 - Transaction not found with the given reference ID
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

militaryVerifyPerson

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 last 4 of social false 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
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,
    "history": {
      "identifier": "8037315c-6997-4c40-87ca-8a835978423b",
      "verifications": 1,
      "verified_last": "2018-01-01T10:00:00Z"
    },
    "attributes": {
      "rank": "Captain",
      "branch": "Army",
      "status": "Service Member",
      "service_start_date": "2018-01-01T10:00:00Z",
      "service_stop_date": "2018-01-01T10:00:00Z"
    }
  }
}
Status: 401 - Invalid authentication credentials
Status: 403 - Credentials do not have access to given resource
Status: 404 - Accessed resource does not exist
Status: 422 - Invalid or missing input parameters
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

militaryVerifyUpload

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 (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
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,
    "history": {
      "identifier": "8037315c-6997-4c40-87ca-8a835978423b",
      "verifications": 1,
      "verified_last": "2018-01-01T10:00:00Z"
    },
    "attributes": {
      "rank": "Captain",
      "branch": "Army",
      "status": "Service Member",
      "service_start_date": "2018-01-01T10:00:00Z",
      "service_stop_date": "2018-01-01T10:00:00Z"
    }
  }
}
Status: 205 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 205,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false
  }
}
Status: 210 - Transaction rejected after review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 205,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": "Document is unreadable"
  }
}
Status: 300 - Transaction unsuccessful
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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",
    "reason_code": "12345"
  }
}
Status: 310 - Validation errors
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": "can't be blank",
    "birth_date": "is not a valid date"
  }
}
Status: 401 - Invalid authentication credentials
Status: 403 - Credentials do not have access to given resource
Status: 404 - Accessed resource does not exist
Status: 422 - Invalid or missing input parameters
Status: 3100 - Transaction not found with the given reference ID
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors

militaryStatus{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
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,
    "history": {
      "identifier": "8037315c-6997-4c40-87ca-8a835978423b",
      "verifications": 1,
      "verified_last": "2018-01-01T10:00:00Z"
    },
    "attributes": {
      "rank": "Captain",
      "branch": "Army",
      "status": "Service Member",
      "service_start_date": "2018-01-01T10:00:00Z",
      "service_stop_date": "2018-01-01T10:00:00Z"
    }
  }
}
Status: 205 - Transaction pending review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 205,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false
  }
}
Status: 210 - Transaction rejected after review
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 205,
    "message": "Transaction pending review",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "result": {
    "verified": false,
    "reason": "Document is unreadable"
  }
}
Status: 300 - Transaction unsuccessful
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "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",
    "reason_code": "12345"
  }
}
Status: 310 - Validation errors
Example arrow_drop_down arrow_drop_up
Content Type
application/json
Example
{
  "reference_id": "f9e85bac-068c-47ea-bb4f-d9fa7753743d",
  "status": {
    "code": 310,
    "message": "Transaction unsuccessful",
    "created": "2018-01-01T10:00:00Z",
    "updated": "2018-01-01T10:00:00Z"
  },
  "errors": {
    "fname": "can't be blank",
    "birth_date": "is not a valid date"
  }
}
Status: 401 - Invalid authentication credentials
Status: 403 - Credentials do not have access to given resource
Status: 404 - Accessed resource does not exist
Status: 422 - Invalid or missing input parameters
Status: 3100 - Transaction not found with the given reference ID
Status: 429 - Rate limit exceeded
Status: 500 - Internal service errors