Verity API

Verity API Documentation

Introduction

Verity provides REST API services to facilitate external data requests to pull and/or push lead and student record updates. This section of the Verity API documentation describes the available methods that could be used to request Verity lists and Verity lead/student records, as well as update existing lead/student records. These API methods do not support new lead delivery. For new lead delivery into Verity, please refer to the lead post documentation. Values passed via API methods are expected to be UTF-8 encoded. This is typical for web communication - but if characters from other languages are not received as expected, we recommend that character encoding is reviewed. This document includes product information and high-level specifications for integrating with third-party providers, on behalf of our clients. The information in this document is proprietary and confidential, and it solely meant to be shared with our explicit consent. Overview This Verity API provides services for the following category of requests:

  1. Authorization: use the Authorization method to get a valid token for access to Verity instance
  2. Lead & student record: use this category of methods to request updates to existing lead & student information by Verity Id or External Key (your internal id matched to a Verity Id). With this service, you may issue updates to lead/student statuses, opt-outs/opt-ins, etc.


Overview

This Verity API provides services for the following category of requests:

  1. Authorization: use the Authorization method to get a valid token for access to Verity instance
  2. Lead & student record: use this category of methods to request updates to existing lead & student information by Verity Id or External Key (your internal id matched to a Verity Id). With this service, you may issue updates to lead/student statuses, opt-outs/opt-ins, etc.


Service Catalog

Method URL Service Headers
Authorization
GET connector/Authorization/GetAuthorizationToken Authorization
Documents
POST connector/Documents/AddStudentDocument Documents
POST connector/Documents/DeleteStudentDocument Documents
POST connector/Documents/GetDocument Documents
POST connector/Documents/GetDocumentBase64 Documents
POST connector/Documents/SaveDocumentType Documents
POST connector/Documents/UpdateStudentDocument Documents
Leads
POST connector/Leads/AddNewLead Leads
POST connector/Leads/GetApplicantData Leads
POST connector/Leads/GetLeadPersonalData Leads
POST connector/Leads/SaveReference Leads
POST connector/Leads/UpdateExternalLeadId Leads
POST connector/Leads/UpdateLeadPersonalData Leads
POST connector/Leads/UpdateLeadStatus Leads
POST connector/Leads/UpdateOptin Leads
POST connector/Leads/UpdateOptout Leads
List
POST connector/List/GetListNames List
POST connector/List/GetListValues List
POST connector/List/UpdateCustomFields List

Authorization

Verity API use “Authentication” header to allow data access. All requests to this API must be authorized using a secret token that you must obtain during the authentication process. Authentication is done via the “authentication” HTTP header.
*Note: Please contact Verity support for providing the access credentials. ;

connector/Authorization/GetAuthorizationToken GET

https://api.verityiq.com/connector/Authorization/GetAuthorizationToken
HEADERS: Content-Type: application/x-www-form-urlencoded GET connector/Authorization/GetAuthorizationToken
Request Response

application/json, text/json

{
  "username": "string",
  "password": "string"
}
SUCCESSFULL: { 'access_token': 'SIQmnU6fmLBAQ6789E …",', 'token_type' : 'bearer' }

Documents

connector/Documents/AddStudentDocument POST

https://api.verityiq.com/connector/Documents/AddStudentDocument
HEADERS: Authorization: bearer authorization_token POST connector/Documents/AddStudentDocument
Request Response

application/json, text/json

{
  "VerityLeadId": 1,
  "ExternalLeadId": "string",
  "DocumentStatus": "string",
  "ExpirationDate": "2024-11-20T14:22:20.8791228+00:00",
  "DueDate": "2024-11-20T14:22:20.8791228+00:00",
  "DocumentSource": "string",
  "ApprovalCode": "string",
  "User": "string",
  "DocumentType": "string",
  "DocumentFileName": "string",
  "Term": "string",
  "ValidityDate": "2024-11-20T14:22:20.8791228+00:00",
  "FileStream": null,
  "Base64File": "string"
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "UploadedDocumentId": 1,
    "TransactionId": "string",
    "VerityLeadId": 3,
    "ExternalLeadId": "string",
    "DocumentStatus": "string",
    "ExpirationDate": "2024-11-20T14:22:20.9103737+00:00",
    "DueDate": "2024-11-20T14:22:20.9103737+00:00",
    "DocumentSource": "string",
    "ApprovalCode": "string",
    "User": "string",
    "DocumentType": "string",
    "DocumentFileName": "string",
    "Term": "string",
    "ValidityDate": "2024-11-20T14:22:20.9103737+00:00",
    "FileStream": null,
    "Base64File": "string"
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Documents/DeleteStudentDocument POST

https://api.verityiq.com/connector/Documents/DeleteStudentDocument
HEADERS: Authorization: bearer authorization_token POST connector/Documents/DeleteStudentDocument
Request Response

application/json, text/json

{
  "TransactionId": "string",
  "VerityLeadId": 2,
  "ExternalLeadId": "string"
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "TransactionId": "string",
    "VerityLeadId": 2,
    "ExternalLeadId": "string"
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Documents/GetDocument POST

https://api.verityiq.com/connector/Documents/GetDocument
HEADERS: Authorization: bearer authorization_token POST connector/Documents/GetDocument
Request Response

application/json, text/json

{
  "TransactionId": "string",
  "VerityLeadId": 2,
  "ExternalLeadId": "string"
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Documents/GetDocumentBase64 POST

https://api.verityiq.com/connector/Documents/GetDocumentBase64
HEADERS: Authorization: bearer authorization_token POST connector/Documents/GetDocumentBase64
Request Response

application/json, text/json

{
  "TransactionId": "string",
  "VerityLeadId": 2,
  "ExternalLeadId": "string"
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Documents/SaveDocumentType POST

https://api.verityiq.com/connector/Documents/SaveDocumentType
HEADERS: Authorization: bearer authorization_token POST connector/Documents/SaveDocumentType
Request Response

application/json, text/json

{
  "CategoryCode": "string",
  "CategoryName": "string",
  "TypeCode": "string",
  "TypeName": "string",
  "ValidityDuration": 1
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "CategoryCode": "string",
    "CategoryName": "string",
    "TypeCode": "string",
    "TypeName": "string",
    "ValidityDuration": 1
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Documents/UpdateStudentDocument POST

https://api.verityiq.com/connector/Documents/UpdateStudentDocument
HEADERS: Authorization: bearer authorization_token POST connector/Documents/UpdateStudentDocument
Request Response

application/json, text/json

{
  "TransactionId": "string",
  "VerityLeadId": 2,
  "ExternalLeadId": "string",
  "DocumentStatus": "string",
  "ExpirationDate": "2024-11-20T14:22:20.941626+00:00",
  "DueDate": "2024-11-20T14:22:20.941626+00:00",
  "DocumentSource": "string",
  "ApprovalCode": "string",
  "User": "string",
  "DocumentType": "string",
  "DocumentFileName": "string",
  "Term": "string",
  "ValidityDate": "2024-11-20T14:22:20.941626+00:00",
  "FileStream": null,
  "Base64File": "string"
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "UploadedDocumentId": 1,
    "TransactionId": "string",
    "VerityLeadId": 3,
    "ExternalLeadId": "string",
    "DocumentStatus": "string",
    "ExpirationDate": "2024-11-20T14:22:20.941626+00:00",
    "DueDate": "2024-11-20T14:22:20.941626+00:00",
    "DocumentSource": "string",
    "ApprovalCode": "string",
    "User": "string",
    "DocumentType": "string",
    "DocumentFileName": "string",
    "Term": "string",
    "ValidityDate": "2024-11-20T14:22:20.941626+00:00",
    "FileStream": null,
    "Base64File": "string"
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

Leads

connector/Leads/AddNewLead POST

https://api.verityiq.com/connector/Leads/AddNewLead
HEADERS: Authorization: bearer authorization_token POST connector/Leads/AddNewLead
Request Response

application/json, text/json

{
  "ExternalLeadId": "string",
  "FirstName": "string",
  "LastName": "string",
  "MiddleName": "string",
  "FormerName": "string",
  "NickName": "string",
  "PostalCode": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "Province": "string",
  "Country": "string",
  "Emails": [
    {
      "IsPreferred": true,
      "ContactType": "string",
      "ContactTypeId": 1,
      "EmailAddress": "string",
      "IsBad": true,
      "IsOld": true,
      "DoNotEmail": true
    },
    {
      "IsPreferred": true,
      "ContactType": "string",
      "ContactTypeId": 1,
      "EmailAddress": "string",
      "IsBad": true,
      "IsOld": true,
      "DoNotEmail": true
    }
  ],
  "Phones": [
    {
      "IsPreferred": true,
      "ContactType": "string",
      "ContactTypeId": 1,
      "PhoneNumber": "string",
      "IsBad": true,
      "IsOld": true,
      "DoNotText": true,
      "DoNotCall": true
    },
    {
      "IsPreferred": true,
      "ContactType": "string",
      "ContactTypeId": 1,
      "PhoneNumber": "string",
      "IsBad": true,
      "IsOld": true,
      "DoNotText": true,
      "DoNotCall": true
    }
  ],
  "LeadSource": "string",
  "LeadStatus": "string",
  "Program": "string",
  "ProgramOfEnrollment": [
    "string",
    "string"
  ],
  "TermStart": "string",
  "Campus": "string",
  "AdmissionAdvisor": "string",
  "StudentAccountsAdvisor": "string",
  "FinancialAidAdvisor": "string",
  "CareerServicesAdvisor": "string",
  "LeadDateTime": "2024-11-20T14:22:20.9572528+00:00",
  "ExpectedGradDate": "string",
  "LeadType": "string",
  "Gender": "string",
  "BirthDate": "string",
  "EducationLevel": "string",
  "EmploymentStatus": "string",
  "VeteranStatus": "string",
  "Citizenship": "string",
  "Nationality": "string",
  "Ethnicity": "string",
  "PreferredLanguage": "string",
  "GradYear": "string",
  "ProfessionalTitle": "string",
  "Salutation": "string"
}
  • If any emails are provider one of them should be marked as primary (IsPreferred = true)
  • If any phones are provider one of them should be marked as primary (IsPreferred = true)

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "VerityLeadId": 1,
    "ExternalLeadId": "string",
    "PotentialMatches": [
      {
        "FirstName": "string",
        "LastName": "string",
        "PhoneNumber": "string",
        "Email": "string",
        "VerityLeadId": 5,
        "ExternalLeadId": "string"
      },
      {
        "FirstName": "string",
        "LastName": "string",
        "PhoneNumber": "string",
        "Email": "string",
        "VerityLeadId": 5,
        "ExternalLeadId": "string"
      }
    ],
    "ExactMatches": [
      {
        "FirstName": "string",
        "LastName": "string",
        "PhoneNumber": "string",
        "Email": "string",
        "VerityLeadId": 5,
        "ExternalLeadId": "string"
      },
      {
        "FirstName": "string",
        "LastName": "string",
        "PhoneNumber": "string",
        "Email": "string",
        "VerityLeadId": 5,
        "ExternalLeadId": "string"
      }
    ],
    "FirstName": "string",
    "LastName": "string",
    "MiddleName": "string",
    "FormerName": "string",
    "NickName": "string",
    "PostalCode": "string",
    "Address": "string",
    "City": "string",
    "State": "string",
    "Province": "string",
    "Country": "string",
    "Emails": [
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "EmailAddress": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotEmail": true
      },
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "EmailAddress": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotEmail": true
      }
    ],
    "Phones": [
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "PhoneNumber": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotText": true,
        "DoNotCall": true
      },
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "PhoneNumber": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotText": true,
        "DoNotCall": true
      }
    ],
    "LeadSource": "string",
    "LeadStatus": "string",
    "Program": "string",
    "ProgramOfEnrollment": [
      "string",
      "string"
    ],
    "TermStart": "string",
    "Campus": "string",
    "AdmissionAdvisor": "string",
    "StudentAccountsAdvisor": "string",
    "FinancialAidAdvisor": "string",
    "CareerServicesAdvisor": "string",
    "LeadDateTime": "2024-11-20T14:22:20.9884785+00:00",
    "ExpectedGradDate": "string",
    "LeadType": "string",
    "Gender": "string",
    "BirthDate": "string",
    "EducationLevel": "string",
    "EmploymentStatus": "string",
    "VeteranStatus": "string",
    "Citizenship": "string",
    "Nationality": "string",
    "Ethnicity": "string",
    "PreferredLanguage": "string",
    "GradYear": "string",
    "ProfessionalTitle": "string",
    "Salutation": "string"
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }
Email configuration: The email list provided does not contain any emails marked as primary (IsPreferred = true) { 'MESSAGE': 'Please provide at least one primary Email', 'Success' : false, }
Email configuration: The email list provided contains multiple emails marked as primary (IsPreferred = true) { 'MESSAGE': 'Multiple Emails were marked as primary. Only one Email can be marked as primary.', 'Success' : false, }
Phone configuration: The phone list provided does not contain any phones marked as primary (IsPreferred = true) { 'MESSAGE': 'Please provide at least one primary Phone', 'Success' : false, }
Phone configuration: The phone list provided contains multiple phones marked as primary (IsPreferred = true) { 'MESSAGE': 'Multiple Phones were marked as primary. Only one Phone can be marked as primary.', 'Success' : false, }
Duplicate rule: Exact matches were found based on the duplicate rule (FirstName AND LastName AND (PhoneNumber OR Email)) { 'MESSAGE': 'Unable to add the lead. There are some matches based on the data provided.', 'Success' : false, }

connector/Leads/GetApplicantData POST

https://api.verityiq.com/connector/Leads/GetApplicantData
HEADERS: Authorization: bearer authorization_token POST connector/Leads/GetApplicantData
Request Response

application/json, text/json

{
  "ApplicationId": "abf96da6-d512-4623-897f-6034988e28e3",
  "ApplicationIds": [
    "41d43727-6845-4e91-8775-edc838717e1a",
    "a5107c72-1a71-4fbb-aaf6-4e5cd1fea788"
  ],
  "VerityLeadId": 1,
  "VerityContactId": "2485afa3-06d4-4154-aa10-aad23fa6e5b3",
  "ExternalLeadId": "string",
  "IncludeInfo": [
    0,
    0
  ],
  "PageNumber": 3,
  "PageSize": 4
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "VerityContactId": "e71d1f9f-aed0-4787-a987-73d6ae98577b",
    "Inquiry": {
      "School": "string",
      "LeadSourceCategory": "string",
      "LeadStatusCategory": "string",
      "InquiryDate": "2024-11-20T14:22:21.0509808+00:00",
      "LeadSource": "string",
      "LeadSourceId": 1,
      "LeadStatus": "string",
      "LeadStatusId": 1,
      "ProgramOfInterest": "string",
      "ProgramOfInterestId": 1,
      "TermStart": "string",
      "TermStartDate": "2024-11-20T14:22:21.0509808+00:00",
      "Campus": "string",
      "CampusId": 1,
      "AdmissionsAdvisor": "string",
      "AdmissionsAdvisorId": 1,
      "FinancialAdvisor": "string",
      "FinancialAdvisorId": 1,
      "StudentAccountsAdvisor": "string",
      "StudentAccountsAdvisorId": 1,
      "CareerServicesAdvisor": "string",
      "CareerServicesAdvisorId": 1,
      "ExpectedGradDateCode": "string",
      "ExpectedGradDate": "2024-11-20T14:22:21.0509808+00:00",
      "LeadType": "string",
      "LeadTypeId": 1,
      "ProgramOfEnrollment": [
        "string",
        "string"
      ]
    },
    "Application": [
      {
        "ApplicationId": "8b3ef0da-271d-4395-8896-7a1440b202bb",
        "InquiryId": "13825e80-726f-45e3-a5bb-594a6389532c",
        "DateCreated": "2024-11-20T14:22:21.0509808+00:00",
        "LastUpdated": "2024-11-20T14:22:21.0509808+00:00",
        "ApplicationDateStarted": "2024-11-20T14:22:21.0509808+00:00",
        "Status": "string",
        "StatusId": 1,
        "School": "string",
        "Campus": "string",
        "CampusId": 1,
        "ProgramOfEnrollment": "string",
        "ProgramOfEnrollmentCode": "string",
        "ProgramOfEnrollmentId": 1,
        "Shift": "string",
        "ShiftId": 1,
        "StartDateCode": "string",
        "StartDate": "2024-11-20T14:22:21.0509808+00:00",
        "ExpectedGradDateCode": "string",
        "ExpectedGradDate": "2024-11-20T14:22:21.0509808+00:00",
        "AdmissionsAdvisor": "string",
        "AdmissionsAdvisorId": 1,
        "FinancialAdvisor": "string",
        "FinancialAdvisorId": 1,
        "StudentAccountsAdvisor": "string",
        "StudentAccountsAdvisorId": 1,
        "CareerServicesAdvisor": "string",
        "CareerServicesAdvisorId": 1,
        "ParentSignatureRequired": true,
        "RegistrationFee": 1.0,
        "FeeWaived": true
      },
      {
        "ApplicationId": "8b3ef0da-271d-4395-8896-7a1440b202bb",
        "InquiryId": "13825e80-726f-45e3-a5bb-594a6389532c",
        "DateCreated": "2024-11-20T14:22:21.0509808+00:00",
        "LastUpdated": "2024-11-20T14:22:21.0509808+00:00",
        "ApplicationDateStarted": "2024-11-20T14:22:21.0509808+00:00",
        "Status": "string",
        "StatusId": 1,
        "School": "string",
        "Campus": "string",
        "CampusId": 1,
        "ProgramOfEnrollment": "string",
        "ProgramOfEnrollmentCode": "string",
        "ProgramOfEnrollmentId": 1,
        "Shift": "string",
        "ShiftId": 1,
        "StartDateCode": "string",
        "StartDate": "2024-11-20T14:22:21.0509808+00:00",
        "ExpectedGradDateCode": "string",
        "ExpectedGradDate": "2024-11-20T14:22:21.0509808+00:00",
        "AdmissionsAdvisor": "string",
        "AdmissionsAdvisorId": 1,
        "FinancialAdvisor": "string",
        "FinancialAdvisorId": 1,
        "StudentAccountsAdvisor": "string",
        "StudentAccountsAdvisorId": 1,
        "CareerServicesAdvisor": "string",
        "CareerServicesAdvisorId": 1,
        "ParentSignatureRequired": true,
        "RegistrationFee": 1.0,
        "FeeWaived": true
      }
    ],
    "Documents": [
      {
        "DocumentType": "string",
        "DocumentTypeId": 1,
        "FileName": "string",
        "FilePath": "string",
        "UploadedUtc": "2024-11-20T14:22:21.0509808+00:00",
        "UploadedBy": "string",
        "DocumentStatus": "string",
        "DocumentStatusId": 6,
        "ExpirationDate": "2024-11-20T14:22:21.0509808+00:00",
        "DueDate": "2024-11-20T14:22:21.0509808+00:00",
        "DocumentSource": "string",
        "ApprovalCode": "string",
        "UserId": "string",
        "DocumentFileName": "string",
        "TransactionId": "string",
        "TermStartCode": "string",
        "TermStart": "2024-11-20T14:22:21.0509808+00:00",
        "IsRevised": true,
        "ValidityDate": "2024-11-20T14:22:21.0509808+00:00",
        "VerityLeadId": 1,
        "ApplicationId": "daa51b59-a0a7-4a31-9852-c401bb86479f",
        "ApplicationDocumentStatus": "string",
        "ApplicationDocumentStatusId": 1,
        "MimeType": "string"
      },
      {
        "DocumentType": "string",
        "DocumentTypeId": 1,
        "FileName": "string",
        "FilePath": "string",
        "UploadedUtc": "2024-11-20T14:22:21.0509808+00:00",
        "UploadedBy": "string",
        "DocumentStatus": "string",
        "DocumentStatusId": 6,
        "ExpirationDate": "2024-11-20T14:22:21.0509808+00:00",
        "DueDate": "2024-11-20T14:22:21.0509808+00:00",
        "DocumentSource": "string",
        "ApprovalCode": "string",
        "UserId": "string",
        "DocumentFileName": "string",
        "TransactionId": "string",
        "TermStartCode": "string",
        "TermStart": "2024-11-20T14:22:21.0509808+00:00",
        "IsRevised": true,
        "ValidityDate": "2024-11-20T14:22:21.0509808+00:00",
        "VerityLeadId": 1,
        "ApplicationId": "daa51b59-a0a7-4a31-9852-c401bb86479f",
        "ApplicationDocumentStatus": "string",
        "ApplicationDocumentStatusId": 1,
        "MimeType": "string"
      }
    ],
    "CustomFields": [
      {
        "Id": 1,
        "Name": "string",
        "Value": "string"
      },
      {
        "Id": 1,
        "Name": "string",
        "Value": "string"
      }
    ],
    "PersonalData": {
      "Salutation": "string",
      "FirstName": "string",
      "MiddleName": "string",
      "LastName": "string",
      "FormerName": "string",
      "Nickname": "string",
      "ProfessionalTitle": "string",
      "BirthDate": "2024-11-20T14:22:21.0509808+00:00",
      "Ssn": "string"
    },
    "Phones": [
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "PhoneNumber": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotText": true,
        "DoNotCall": true
      },
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "PhoneNumber": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotText": true,
        "DoNotCall": true
      }
    ],
    "Emails": [
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "EmailAddress": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotEmail": true
      },
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "EmailAddress": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotEmail": true
      }
    ],
    "Addresses": [
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "Address": "string",
        "Line2": "string",
        "City": "string",
        "State": "string",
        "StateId": 1,
        "County": "string",
        "Province": "string",
        "PostalCode": "string",
        "Country": "string",
        "CountryId": 1,
        "IsBad": true,
        "IsOld": true
      },
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "Address": "string",
        "Line2": "string",
        "City": "string",
        "State": "string",
        "StateId": 1,
        "County": "string",
        "Province": "string",
        "PostalCode": "string",
        "Country": "string",
        "CountryId": 1,
        "IsBad": true,
        "IsOld": true
      }
    ],
    "References": [
      {
        "FirstName": "string",
        "MiddleName": "string",
        "LastName": "string",
        "PhoneNumber": "string",
        "EmailAddress": "string",
        "Relationship": "string",
        "Address": "string",
        "City": "string",
        "Province": "string",
        "PostalCode": "string",
        "State": "string",
        "StateId": 1,
        "Country": "string",
        "CountryId": 1,
        "IsParentSigner": true
      },
      {
        "FirstName": "string",
        "MiddleName": "string",
        "LastName": "string",
        "PhoneNumber": "string",
        "EmailAddress": "string",
        "Relationship": "string",
        "Address": "string",
        "City": "string",
        "Province": "string",
        "PostalCode": "string",
        "State": "string",
        "StateId": 1,
        "Country": "string",
        "CountryId": 1,
        "IsParentSigner": true
      }
    ],
    "Demographics": {
      "HigherEducationCredential": "string",
      "HigherEducationCredentialId": 1,
      "Ethnicity": "string",
      "EthnicityId": 1,
      "Citizenship": "string",
      "CitizenshipId": 1,
      "VeteranStatus": "string",
      "VeteranStatusId": 1,
      "Gender": "string",
      "GenderId": 64,
      "PreferredLanguage": "string",
      "PreferredLanguageId": 1,
      "MaritalStatus": "string",
      "MaritalStatusId": 1,
      "Nationality": "string",
      "NationalityId": 1,
      "PlacementStatus": "string",
      "PlacementStatusId": 1
    },
    "HighSchool": {
      "Credential": "string",
      "CredentialId": 1,
      "Name": "string",
      "GraduationDate": "2024-11-20T14:22:21.0509808+00:00",
      "GraduationYear": 1,
      "DidNotGraduate": true,
      "Address": "string",
      "City": "string",
      "State": "string",
      "StateId": 1,
      "Province": "string",
      "PostalCode": "string",
      "Country": "string",
      "CountryId": 1
    },
    "PreviousEducation": [
      {
        "College": "string",
        "AttendedFrom": "2024-11-20T14:22:21.0509808+00:00",
        "AttendedTo": "2024-11-20T14:22:21.0509808+00:00",
        "GraduationDate": "2024-11-20T14:22:21.0509808+00:00",
        "GraduationYear": 1,
        "Degree": "string",
        "DegreeId": 1,
        "Address": "string",
        "City": "string",
        "State": "string",
        "StateId": 1,
        "Province": "string",
        "PostalCode": "string",
        "Country": "string",
        "CountryId": 1,
        "CollegeProvince": "string"
      },
      {
        "College": "string",
        "AttendedFrom": "2024-11-20T14:22:21.0509808+00:00",
        "AttendedTo": "2024-11-20T14:22:21.0509808+00:00",
        "GraduationDate": "2024-11-20T14:22:21.0509808+00:00",
        "GraduationYear": 1,
        "Degree": "string",
        "DegreeId": 1,
        "Address": "string",
        "City": "string",
        "State": "string",
        "StateId": 1,
        "Province": "string",
        "PostalCode": "string",
        "Country": "string",
        "CountryId": 1,
        "CollegeProvince": "string"
      }
    ],
    "VerityLeadId": 1,
    "ExternalLeadId": "string"
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Leads/GetLeadPersonalData POST

https://api.verityiq.com/connector/Leads/GetLeadPersonalData
HEADERS: Authorization: bearer authorization_token POST connector/Leads/GetLeadPersonalData
Request Response

application/json, text/json

{
  "VerityLeadId": 1,
  "ExternalLeadId": "string"
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "FirstName": "string",
    "LastName": "string",
    "MiddleName": "string",
    "FormerName": "string",
    "NickName": "string",
    "ProfessionalTitle": "string",
    "Salutation": "string",
    "PhoneNumber": "string",
    "Email": "string",
    "PostalCode": "string",
    "Address": "string",
    "City": "string",
    "State": {
      "Id": 1,
      "Name": "string"
    },
    "Province": "string",
    "Country": {
      "Id": 1,
      "Name": "string"
    },
    "Gender": "string",
    "BirthDate": "string",
    "GradYear": "string",
    "EducationLevel": {
      "Id": 1,
      "Name": "string"
    },
    "EmploymentStatus": {
      "Id": 1,
      "Name": "string"
    },
    "VeteranStatus": {
      "Id": 1,
      "Name": "string"
    },
    "Citizenship": {
      "Id": 1,
      "Name": "string"
    },
    "Nationality": {
      "Id": 1,
      "Name": "string"
    },
    "Ethnicity": {
      "Id": 1,
      "Name": "string"
    },
    "PreferredLanguage": {
      "Id": 1,
      "Name": "string"
    },
    "LeadSource": {
      "Id": 1,
      "Name": "string"
    },
    "LeadStatus": {
      "Id": 1,
      "Name": "string"
    },
    "Program": {
      "Id": 1,
      "Name": "string"
    },
    "TermStart": "string",
    "Campus": {
      "Id": 1,
      "Name": "string"
    },
    "AdmissionAdvisor": {
      "Id": 1,
      "Name": "string"
    },
    "CareerServicesAdvisor": {
      "Id": 1,
      "Name": "string"
    },
    "FinancialServicesAdvisor": {
      "Id": 1,
      "Name": "string"
    },
    "StudentAccountsAdvisor": {
      "Id": 1,
      "Name": "string"
    },
    "LeadType": {
      "Id": 1,
      "Name": "string"
    },
    "ProgramsOfEnrollment": [
      {
        "Id": 1,
        "Name": "string"
      },
      {
        "Id": 1,
        "Name": "string"
      }
    ],
    "ExpectedGradDate": "string",
    "LeadDateTime": "string",
    "CustomFields": [
      {
        "Id": 1,
        "Name": "string",
        "Value": "string"
      },
      {
        "Id": 1,
        "Name": "string",
        "Value": "string"
      }
    ],
    "VerityLeadId": 20,
    "ExternalLeadId": "string"
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Leads/SaveReference POST

https://api.verityiq.com/connector/Leads/SaveReference
HEADERS: Authorization: bearer authorization_token POST connector/Leads/SaveReference
Request Response

application/json, text/json

{
  "VerityLeadId": 1,
  "ExternalLeadId": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "PhoneNumber": "string",
  "EmailAddress": "string",
  "Relationship": "string",
  "Address": "string",
  "City": "string",
  "Province": "string",
  "PostalCode": "string",
  "State": "string",
  "StateId": 1,
  "Country": "string",
  "CountryId": 1,
  "IsParentSigner": true
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "Id": 1,
    "VerityLeadId": 2,
    "ExternalLeadId": "string",
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "PhoneNumber": "string",
    "EmailAddress": "string",
    "Relationship": "string",
    "Address": "string",
    "City": "string",
    "Province": "string",
    "PostalCode": "string",
    "State": "string",
    "StateId": 1,
    "Country": "string",
    "CountryId": 1,
    "IsParentSigner": true
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Leads/UpdateExternalLeadId POST

https://api.verityiq.com/connector/Leads/UpdateExternalLeadId
HEADERS: Authorization: bearer authorization_token POST connector/Leads/UpdateExternalLeadId
Request Response

application/json, text/json

{
  "VerityLeadId": 1,
  "ExternalLeadId": "string"
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "VerityLeadId": 1,
    "ExternalLeadId": "string"
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Leads/UpdateLeadPersonalData POST

https://api.verityiq.com/connector/Leads/UpdateLeadPersonalData
HEADERS: Authorization: bearer authorization_token POST connector/Leads/UpdateLeadPersonalData
Request Response

application/json, text/json

{
  "Email": null,
  "Phone": "",
  "PhoneContactType": "string",
  "PostalCode": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "Province": "string",
  "Country": "string",
  "Emails": [
    {
      "IsPreferred": true,
      "ContactType": "string",
      "ContactTypeId": 1,
      "EmailAddress": "string",
      "IsBad": true,
      "IsOld": true,
      "DoNotEmail": true
    },
    {
      "IsPreferred": true,
      "ContactType": "string",
      "ContactTypeId": 1,
      "EmailAddress": "string",
      "IsBad": true,
      "IsOld": true,
      "DoNotEmail": true
    }
  ],
  "Phones": [
    {
      "IsPreferred": true,
      "ContactType": "string",
      "ContactTypeId": 1,
      "PhoneNumber": "string",
      "IsBad": true,
      "IsOld": true,
      "DoNotText": true,
      "DoNotCall": true
    },
    {
      "IsPreferred": true,
      "ContactType": "string",
      "ContactTypeId": 1,
      "PhoneNumber": "string",
      "IsBad": true,
      "IsOld": true,
      "DoNotText": true,
      "DoNotCall": true
    }
  ],
  "FirstName": "string",
  "LastName": "string",
  "MiddleName": "string",
  "FormerName": "string",
  "NickName": "string",
  "ProfessionalTitle": "string",
  "Salutation": "string",
  "Gender": "string",
  "BirthDate": "string",
  "EducationLevel": "string",
  "EmploymentStatus": "string",
  "VeteranStatus": "string",
  "Citizenship": "string",
  "Nationality": "string",
  "Ethnicity": "string",
  "PreferredLanguage": "string",
  "GradYear": "string",
  "LeadSource": "string",
  "LeadStatus": "string",
  "Program": "string",
  "ProgramOfEnrollment": [
    "string",
    "string"
  ],
  "TermStart": "string",
  "Campus": "string",
  "AdmissionAdvisor": "string",
  "LeadType": "string",
  "StudentAccountsAdvisor": "string",
  "FinancialAidAdvisor": "string",
  "CareerServicesAdvisor": "string",
  "LeadDateTime": "2024-11-20T14:22:21.2854521+00:00",
  "ExpectedGradDate": "string",
  "VerityLeadId": 38,
  "ExternalLeadId": "string"
}

application/json, text/json

{
  "Warnings": "string",
  "Message": "string",
  "Success": true,
  "Data": {
    "Email": null,
    "Phone": "",
    "PhoneContactType": "string",
    "PostalCode": "string",
    "Address": "string",
    "City": "string",
    "State": "string",
    "Province": "string",
    "Country": "string",
    "Emails": [
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "EmailAddress": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotEmail": true
      },
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "EmailAddress": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotEmail": true
      }
    ],
    "Phones": [
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "PhoneNumber": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotText": true,
        "DoNotCall": true
      },
      {
        "IsPreferred": true,
        "ContactType": "string",
        "ContactTypeId": 1,
        "PhoneNumber": "string",
        "IsBad": true,
        "IsOld": true,
        "DoNotText": true,
        "DoNotCall": true
      }
    ],
    "FirstName": "string",
    "LastName": "string",
    "MiddleName": "string",
    "FormerName": "string",
    "NickName": "string",
    "ProfessionalTitle": "string",
    "Salutation": "string",
    "Gender": "string",
    "BirthDate": "string",
    "EducationLevel": "string",
    "EmploymentStatus": "string",
    "VeteranStatus": "string",
    "Citizenship": "string",
    "Nationality": "string",
    "Ethnicity": "string",
    "PreferredLanguage": "string",
    "GradYear": "string",
    "LeadSource": "string",
    "LeadStatus": "string",
    "Program": "string",
    "ProgramOfEnrollment": [
      "string",
      "string"
    ],
    "TermStart": "string",
    "Campus": "string",
    "AdmissionAdvisor": "string",
    "LeadType": "string",
    "StudentAccountsAdvisor": "string",
    "FinancialAidAdvisor": "string",
    "CareerServicesAdvisor": "string",
    "LeadDateTime": "2024-11-20T14:22:21.3010754+00:00",
    "ExpectedGradDate": "string",
    "VerityLeadId": 38,
    "ExternalLeadId": "string"
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Leads/UpdateLeadStatus POST

https://api.verityiq.com/connector/Leads/UpdateLeadStatus
HEADERS: Authorization: bearer authorization_token, Content-Type: application/json OR application/x-www-form-urlencoded POST connector/Leads/UpdateLeadStatus
Request Response

application/json, text/json

{
  "StatusId": 1,
  "VerityLeadId": 2,
  "ExternalLeadId": "string"
}
  • Only one of the identifier fields (VerityLeadId or ExternalLeadId) is required
  • Use list methods to get a valid Verity status id
  • Status change API will also trigger any status change workflows if configured

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "StatusId": 1,
    "VerityLeadId": 2,
    "ExternalLeadId": "string"
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Leads/UpdateOptin POST

https://api.verityiq.com/connector/Leads/UpdateOptin
HEADERS: Authorization: bearer authorization_token POST connector/Leads/UpdateOptin
Request Response

application/json, text/json

{
  "VerityLeadId": 1,
  "ExternalLeadId": "string",
  "Emails": [
    "string",
    "string"
  ],
  "Phones": [
    "string",
    "string"
  ],
  "Text": [
    "string",
    "string"
  ]
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "VerityLeadId": 1,
    "ExternalLeadId": "string",
    "Emails": [
      "string",
      "string"
    ],
    "Phones": [
      "string",
      "string"
    ],
    "Text": [
      "string",
      "string"
    ]
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/Leads/UpdateOptout POST

https://api.verityiq.com/connector/Leads/UpdateOptout
HEADERS: Authorization: bearer authorization_token POST connector/Leads/UpdateOptout
Request Response

application/json, text/json

{
  "VerityLeadId": 1,
  "ExternalLeadId": "string",
  "Emails": [
    "string",
    "string"
  ],
  "Phones": [
    "string",
    "string"
  ],
  "Text": [
    "string",
    "string"
  ]
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "VerityLeadId": 1,
    "ExternalLeadId": "string",
    "Emails": [
      "string",
      "string"
    ],
    "Phones": [
      "string",
      "string"
    ],
    "Text": [
      "string",
      "string"
    ]
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

List

connector/List/GetListNames POST

https://api.verityiq.com/connector/List/GetListNames
HEADERS: Authorization: bearer authorization_token POST connector/List/GetListNames
Request Response

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": [
    {
      "Id": 1,
      "Name": "string"
    },
    {
      "Id": 1,
      "Name": "string"
    }
  ]
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/List/GetListValues POST

https://api.verityiq.com/connector/List/GetListValues
HEADERS: Authorization: bearer authorization_token POST connector/List/GetListValues
Request Response

application/json, text/json

{
  "Id": 1,
  "Name": "string"
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": [
    {
      "Id": 1,
      "Name": "string"
    },
    {
      "Id": 1,
      "Name": "string"
    }
  ]
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }

connector/List/UpdateCustomFields POST

https://api.verityiq.com/connector/List/UpdateCustomFields
HEADERS: Authorization: bearer authorization_token POST connector/List/UpdateCustomFields
Request Response

application/json, text/json

{
  "VerityLeadId": 1,
  "ExternalLeadId": "string",
  "CustomFields": [
    {
      "CustomFieldId": 1,
      "Name": "string",
      "Value": "string"
    },
    {
      "CustomFieldId": 1,
      "Name": "string",
      "Value": "string"
    }
  ]
}

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "VerityLeadId": 1,
    "ExternalLeadId": "string",
    "CustomFields": [
      {
        "CustomFieldId": 1,
        "Name": "string",
        "Value": "string"
      },
      {
        "CustomFieldId": 1,
        "Name": "string",
        "Value": "string"
      }
    ]
  }
}
SUCCESSFULL: { 'MESSAGE': 'OK', 'Success' : true, 'Data' : { ... } }
MISSING/WRONG AUTHORIZATION: { 'MESSAGE': 'Invalid data provided', 'Success' : false, 'Data' : null }
INVALID VerityLeadId and/or ExternalLeadId: { 'MESSAGE': 'Invalid lead credentials provided ( VerityLeadId or ExternalLeadId)', 'Success' : false, 'Data' : null }