The AuraData API is a RESTful API that uses JSON objects and is available exclusively to full subscribers of the AuraData system. To gain access, you'll need to agree to the AuraData API Agreement.
\nFor more information on how to sign off and start using the API, feel free to reach out to us at service@auradata.com!
\nFollow these steps to integrate with the AuraData API and utilize its verification services.
\ninstitution/getall endpoint to retrieve the list of institutions along with their corresponding ID numbers.verification/create endpoint to submit a verification request. Make sure to include the required parameters, such as the institution ID.verification/get endpoint to check the status and results of your verification request using the tracking ID number obtained in Step 3.Ensure that you handle authorization properly and maintain security best practices while integrating with the API.
\nReview the API documentation for details on request and response formats, as well as other available endpoints.
\nBy following these steps, you'll be able to successfully integrate with the AuraData API and utilize its verification services.
\nThe AuraData API uses JWT tokens for authentication. You must include a JWT token in each request to the AuraData API as a bearer token in the authorization header.
\nIf a JWT token is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\nIf you have questions, feel free to contact us at service@auradata.com. We're here to help!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9965705","collectionId":"caa0f9da-a473-4fc3-b385-98f32266c656","publishedId":"2sAXxJiaSF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-17T21:02:54.000Z"},"item":[{"name":"TokenAuth","item":[{"name":"Authenticate","event":[{"listen":"prerequest","script":{"id":"19d06aec-f2a4-4935-bcc9-f18f96c19f07","exec":[""],"type":"text/javascript","packages":{}}}],"id":"9cf73a6d-f24e-498e-9b52-42b3083af120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": ,\r\n \"userNameOrEmailAddress\": \"\",\r\n \"password\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/api/TokenAuth/Authenticate","description":"This request is used to authenticate the user and obtain a JWT token, which is necessary for authorizing any subsequent API requests. The retrieved JWT token should be included as a Bearer token in the Authorization header for all future requests that require authorization.
{\n \"result\": {\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"expireInSeconds\": 86400,\n \"userId\": 4\n },\n \"success\": true\n}\n\naccessToken field in the result object contains the JWT token. This token must be used in the Authorization header as follows:Authorization: Bearer <accessToken>\n\nexpireInSeconds field indicates the token's validity period in seconds. After this period, the token will expire, and you will need to authenticate again to obtain a new token.This API endpoint retrieves a list of institutions from the AuraData system. The main purpose of this request is to obtain the ID number of institutions, which is necessary for submitting verification requests for those institutions.
\n{\n \"result\": {\n \"totalCount\": 354,\n \"items\": [\n {\n \"name\": \"Acadia University\",\n \"specialInstructions\": null,\n \"id\": 30\n },\n {\n \"name\": \"Adler University\",\n \"specialInstructions\": null,\n \"id\": 679\n }\n ]\n },\n \"targetUrl\": null,\n \"success\": true,\n \"error\": null,\n \"unAuthorizedRequest\": false,\n \"__abp\": true\n}\n\nresult.totalCount:
The total number of institutions available that match the search criteria.
result.items:
An array of institutions matching the query, containing the following fields:
name: The full name of the institution.
specialInstructions: Any special instructions related to the institution (usually null).
id: The unique identifier of the institution, which is required for submitting verification requests.
(optional) Filter the institutions that contain the specified name. This is a partial match search.
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"(optional) Sort the results by a specific property. Typically, this would be properties like name.
\n","type":"text/plain"},"key":"sorting","value":""},{"disabled":true,"description":{"content":"(optional) Number of records to skip for pagination.
\n","type":"text/plain"},"key":"skipCount","value":""},{"disabled":true,"description":{"content":"(optional) Maximum number of records to return in the result set.
\n","type":"text/plain"},"key":"maxResultCount","value":""}],"variable":[]}},"response":[{"id":"a9a20a00-e28a-408f-a4e7-59493887b517","name":"GetAll","originalRequest":{"method":"GET","header":[],"url":{"raw":"/api/services/app/institution/getall","host":[""],"path":["api","services","app","institution","getall"],"query":[{"key":"name","value":"","description":"(optional) Filter the institutions that contain the specified name. This is a partial match search.","disabled":true},{"key":"sorting","value":"","description":"(optional) Sort the results by a specific property. Typically, this would be properties like name.","disabled":true},{"key":"skipCount","value":"","description":"(optional) Number of records to skip for pagination.","disabled":true},{"key":"maxResultCount","value":"","description":"(optional) Maximum number of records to return in the result set.","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e4a0a412-e6b3-4be9-a55c-e5da6433a18b"},{"name":"Get","id":"f744019e-c1b3-42fd-974c-e62f18d6b697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/services/app/institution/get?id=611","description":"This API endpoint retrieves detailed information for a specific institution from the AuraData system. The main purpose of this request is to obtain the details of an institution identified by its unique ID.
\n{\n \"result\": {\n \"name\": \"AuraData Test University\",\n \"specialInstructions\": \"Specific consent requirements, cyber attack, holiday hours - expect delays in responses\",\n \"id\": 611\n },\n \"targetUrl\": null,\n \"success\": true,\n \"error\": null,\n \"unAuthorizedRequest\": false,\n \"__abp\": true\n}\n\nresult.name:
The full name of the institution.
result.specialInstructions:
Any special instructions related to the institution, such as consent requirements or operational notes.
result.id:
The unique identifier of the institution.
(required) The unique identifier of the institution you want to retrieve.
\n","type":"text/plain"},"key":"id","value":"611"}],"variable":[]}},"response":[],"_postman_id":"f744019e-c1b3-42fd-974c-e62f18d6b697"}],"id":"706f9d52-53ac-43a7-8eeb-0c1775e7a9a3","description":"These requests consist of requests related to educational and professional institutions within the AuraData system. They enable users to retrieve and manage information about institutions necessary for processing verification requests.
\nNote: Authorization is not required for any of these requests. Users should avoid storing this information, as it gets updated periodically. If storage is necessary, ensure that the data is refreshed regularly to maintain accuracy.
\nThis collection serves as a central location for accessing institution-related data to support efficient verification processes.
\n","_postman_id":"706f9d52-53ac-43a7-8eeb-0c1775e7a9a3"},{"name":"Verification","item":[{"name":"Create","id":"bcbbfeae-fb70-4267-8321-9fae9fd34cf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"institutions\": [\r\n {\r\n \"credentialEarned\": \"string\",\r\n \"institutionId\": 0,\r\n \"studentNumber\": \"string\",\r\n \"yearOfAccreditation\": 0\r\n }\r\n ],\r\n \"signedForm\": \"string\",\r\n \"subject\": {\r\n \"currentName\": {\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"middleName\": \"string\"\r\n },\r\n \"dateOfBirth\": \"2024-10-01T20:35:26.958Z\",\r\n \"formerName\": {\r\n \"firstName\": \"string\",\r\n \"lastName\": \"string\",\r\n \"middleName\": \"string\"\r\n }\r\n },\r\n \"vc\": {\r\n \"id\": \"string\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/api/services/app/Verification/Create","description":"This request creates a new verification request within the AuraData system, allowing users to submit information about educational or professional institutions for verification.
\nMultiple credentials and institutions can be specified for a single subject
\nA separate request must be submitted for different subjects to maintain clarity in the verification process.
\nEnsure that all required fields are provided in the request body for successful verification request creation.
\n{\n \"id\": 0,\n \"clientReference\": \"string\",\n \"status\": \"string\",\n \"fee\": 0,\n \"subject\": {\n \"currentName\": {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"middleName\": \"string\"\n },\n \"dateOfBirth\": \"2024-10-01T20:35:26.959Z\",\n \"formerName\": {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"middleName\": \"string\"\n }\n },\n \"institutions\": [\n {\n \"credentialEarned\": \"string\",\n \"dateCompleted\": \"2024-10-01T20:35:26.959Z\",\n \"dateCreated\": \"2024-10-01T20:35:26.959Z\",\n \"dateSearchStarted\": \"2024-10-01T20:35:26.959Z\",\n \"institution\": {\n \"id\": 0,\n \"name\": \"string\",\n \"specialInstructions\": \"string\"\n },\n \"status\": \"string\",\n \"studentNumber\": \"string\",\n \"yearOfAccreditation\": 0\n }\n ],\n \"results\": [\n {\n \"id\": 0,\n \"cautionaryIndicator\": \"string\",\n \"credentialEarned\": \"string\",\n \"dateOfConvocation\": \"2024-10-01T20:35:26.959Z\",\n \"graduationYear\": 0,\n \"institution\": {\n \"id\": 0,\n \"name\": \"string\",\n \"specialInstructions\": \"string\"\n },\n \"major\": \"string\",\n \"minor\": \"string\",\n \"specialization\": \"string\",\n \"vc\": \"string\"\n }\n ]\n}\n\nRetrieves the verification status of a specific tracking number.
\nThe API returns a JSON object containing the verification details.
\n{\n \"result\": {\n \"id\": 2400113,\n \"clientReference\": \"ABC1234567\",\n \"status\": \"Completed\",\n \"fee\": 17.00,\n \"subject\": ... // same as Create\n \"institutions\": [\n {\n ...\n \"status\": \"Completed\",\n ...\n },\n {\n ...\n \"status\": \"Completed\",\n ...\n }\n ],\n \"results\": [\n {\n \"cautionaryIndicator\": \"N\",\n \"credentialEarned\": \"20241001\",\n \"dateOfConvocation\": \"2000-10-01T00:00:00Z\",\n \"graduationYear\": 2000,\n \"institution\": {\n \"name\": \"AuraData Test University\",\n \"specialInstructions\": null,\n \"id\": 611\n },\n \"major\": \"\",\n \"minor\": \"\",\n \"specialization\": \"\",\n \"vc\": null // will only be issued if requested in the create request\n },\n {\n \"cautionaryIndicator\": \"N\",\n \"credentialEarned\": \"20241001\",\n \"dateOfConvocation\": \"2000-10-01T00:00:00Z\",\n \"graduationYear\": 2000,\n \"institution\": {\n \"name\": \"AuraData Test University\",\n \"specialInstructions\": null,\n \"id\": 611\n },\n \"major\": \"\",\n \"minor\": \"\",\n \"specialization\": \"\",\n \"vc\": null // will only be issued if requested in the create request\n }\n ]\n },\n \"targetUrl\": null,\n \"success\": true,\n \"error\": null,\n \"unAuthorizedRequest\": false,\n \"__abp\": true\n}\n\nThe clientReference, status, fee, institutions, and subject fields are the same as those in the Create Verification documentation.
\nstatus: Indicates the state of the verification request. This may refer to the overall verification status or the status for a specific institution, as each institution may respond at different times. Possible values include:
\nPending
The authorization form has not been received, was rejected and needs to be resubmitted, or AuraData is still processing the verification.
X (Cancelled)
The verification was cancelled by the subscriber. No transaction fee will be charged.
Completed
The verification process is complete, and a record for the subject was found at the institution.
C (Caution)
The subject must contact the institution before their record can be released.
No File Found
No record for the subject was found at the institution.
The following details are specific to the results field:
\nresults: An array of verification results related to the request.
\ncautionaryIndicator: Indicator for any cautionary notes (e.g., \"Y\" for yes, \"N\" for no). A value of \"Y\" indicates that the institution cannot disclose the file about the subject. In such cases, the subject needs to contact the institution directly to resolve the issue.
\ncredentialEarned: The credential number earned.
\ndateOfConvocation: The date of convocation for the credential.
\ngraduationYear: The year of graduation.
\ninstitution: Details about the institution.
\nname: Name of the institution.
\nspecialInstructions: Any special instructions related to the institution.
\nid: Unique identifier of the institution.
\nmajor: Major field of study (if applicable).
\nminor: Minor field of study (if applicable).
\nspecialization: Specialization (if applicable).
\nvc: Verifiable credential (if applicable). This will only be issued if it was requested in the create request.
\nThe tracking number for which the verification status is requested.
\n","type":"text/plain"},"key":"Id","value":"{{TrackingNumber}}"}],"variable":[]}},"response":[{"id":"85e2e9c3-b890-484d-8c14-61c6473ed9b9","name":"2456332","originalRequest":{"method":"GET","header":[],"url":{"raw":"/api/services/app/Verification/Get?Id={{TrackingNumber}}","host":[""],"path":["api","services","app","Verification","Get"],"query":[{"key":"Id","value":"{{TrackingNumber}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0f2a8cae-28fa-432f-a7fe-f3c772714bbd"}],"id":"177fbf90-9e45-41f7-bab3-27d9eda5151d","event":[{"listen":"prerequest","script":{"id":"65dbe6f9-53dd-4014-a30f-06a51feddbdd","type":"text/javascript","packages":{},"exec":["// Replace 'VARIABLE_NAME' with the actual names of your environment variables\r","const variableNames = ['AURADATA_API_DOMAIN', 'AURADATA_API_ID', 'AURADATA_API_USERNAME', 'AURADATA_API_PASSWORD']; // Add the environment variable names you want to transfer\r","\r","variableNames.forEach(name => {\r"," const value = pm.environment.get(name); // Get the environment variable value\r"," if (value) {\r"," pm.collectionVariables.set(name, value); // Set it as a collection variable\r"," }\r","});\r","\r","\r","// Define the URL using an environment variable\r","const apiUrl = pm.collectionVariables.get('AURADATA_API_DOMAIN'); // Replace 'API_URL' with your actual environment variable name\r","\r","// Define the credentials (username and password) from environment variables\r","const id = pm.collectionVariables.get('AURADATA_API_ID'); // Replace 'USERNAME' with your actual variable name\r","const username = pm.collectionVariables.get('AURADATA_API_USERNAME'); // Replace 'USERNAME' with your actual variable name\r","const password = pm.collectionVariables.get('AURADATA_API_PASSWORD'); // Replace 'PASSWORD' with your actual variable name\r","\r","// Create the JSON body for the POST request\r","const body = {\r"," id: id,\r"," userNameOrEmailAddress: username,\r"," password: password\r","};\r","\r","\r","// Send a POST request to get the token\r","pm.sendRequest({\r"," url: apiUrl + '/api/TokenAuth/Authenticate', // Adjust the endpoint as needed\r"," method: 'POST',\r"," header: {\r"," 'Content-Type': 'application/json' // Set the Content-Type header\r"," },\r"," body: {\r"," mode: 'raw',\r"," raw: JSON.stringify(body) // Convert the body object to JSON\r"," }\r","}, function (err, res) {\r"," if (err) {\r"," console.error(err);\r"," return;\r"," }\r","\r"," // Parse the response\r"," const jsonResponse = res.json();\r","\r"," // Extract the accessToken\r"," const token = jsonResponse.result.accessToken; // Adjust this based on the actual response structure\r","\r"," // Store the token in a collection variable for reuse in other requests\r"," pm.collectionVariables.set('authToken', token);\r","});\r",""]}},{"listen":"test","script":{"id":"fcde1c72-46e2-4e55-9465-9bd83667c835","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"177fbf90-9e45-41f7-bab3-27d9eda5151d","description":""}],"event":[{"listen":"prerequest","script":{"id":"59a1ff3b-bf79-4622-ad5e-c31ee11183de","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3d01bfdc-768c-4c58-b66f-4e26b5d10cf2","type":"text/javascript","exec":[""]}}],"variable":[{"key":"AURADATA_API_DOMAIN","value":""},{"key":"AURADATA_API_ID","value":""},{"key":"AURADATA_API_USERNAME","value":""},{"key":"AURADATA_API_PASSWORD","value":""},{"key":"authToken","value":""}]}