Authorization
connector/Authorization/GetAuthorizationToken GET
Request | Response |
---|---|
application/json, text/json{ "username": "string", "password": "string" } |
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:
This Verity API provides services for the following category of requests:
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 |
Request | Response |
---|---|
application/json, text/json{ "username": "string", "password": "string" } |
Request | Response |
---|---|
application/json, text/json{ "VerityLeadId": 1, "ExternalLeadId": "string", "DocumentStatus": "string", "ExpirationDate": "2024-12-12T09:45:04.2903894+00:00", "DueDate": "2024-12-12T09:45:04.2903894+00:00", "DocumentSource": "string", "ApprovalCode": "string", "User": "string", "DocumentType": "string", "DocumentFileName": "string", "Term": "string", "ValidityDate": "2024-12-12T09:45:04.2903894+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-12-12T09:45:04.3847407+00:00", "DueDate": "2024-12-12T09:45:04.3847407+00:00", "DocumentSource": "string", "ApprovalCode": "string", "User": "string", "DocumentType": "string", "DocumentFileName": "string", "Term": "string", "ValidityDate": "2024-12-12T09:45:04.3847407+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
}
|
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
}
|
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
}
|
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
}
|
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
}
|
Request | Response |
---|---|
application/json, text/json{ "TransactionId": "string", "VerityLeadId": 2, "ExternalLeadId": "string", "DocumentStatus": "string", "ExpirationDate": "2024-12-12T09:45:04.4472604+00:00", "DueDate": "2024-12-12T09:45:04.4472604+00:00", "DocumentSource": "string", "ApprovalCode": "string", "User": "string", "DocumentType": "string", "DocumentFileName": "string", "Term": "string", "ValidityDate": "2024-12-12T09:45:04.4472604+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-12-12T09:45:04.4472604+00:00", "DueDate": "2024-12-12T09:45:04.4472604+00:00", "DocumentSource": "string", "ApprovalCode": "string", "User": "string", "DocumentType": "string", "DocumentFileName": "string", "Term": "string", "ValidityDate": "2024-12-12T09:45:04.462937+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
}
|
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", "RawPhoneNumber": "string", "IsBad": true, "IsOld": true, "DoNotText": true, "DoNotCall": true }, { "IsPreferred": true, "ContactType": "string", "ContactTypeId": 1, "PhoneNumber": "string", "RawPhoneNumber": "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-12-12T09:45:04.462937+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" } |
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", "RawPhoneNumber": "string", "IsBad": true, "IsOld": true, "DoNotText": true, "DoNotCall": true }, { "IsPreferred": true, "ContactType": "string", "ContactTypeId": 1, "PhoneNumber": "string", "RawPhoneNumber": "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-12-12T09:45:04.5566034+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
}
|
Request | Response |
---|---|
application/json, text/json{ "ApplicationId": "c2bd340d-9115-4cca-94e8-75cd421689cf", "ApplicationIds": [ "2fe452e2-ce78-4c0b-bf0a-f2f6c3d03607", "225f34c1-c9d5-4982-904c-37ab0c47ccb1" ], "VerityLeadId": 1, "VerityContactId": "bf242391-bde2-4a40-a020-8afd5f87e893", "ExternalLeadId": "string", "IncludeInfo": [ 0, 0 ], "PageNumber": 3, "PageSize": 4 } |
application/json, text/json{ "Message": "string", "Success": true, "Data": { "VerityContactId": "302c1775-3ed8-4599-82db-81ac6cfefd56", "Inquiry": { "School": "string", "LeadSourceCategory": "string", "LeadStatusCategory": "string", "InquiryDate": "2024-12-12T09:45:04.6665725+00:00", "LeadSource": "string", "LeadSourceId": 1, "LeadStatus": "string", "LeadStatusId": 1, "ProgramOfInterest": "string", "ProgramOfInterestId": 1, "TermStart": "string", "TermStartDate": "2024-12-12T09:45:04.6665725+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-12-12T09:45:04.6665725+00:00", "LeadType": "string", "LeadTypeId": 1, "ProgramOfEnrollment": [ "string", "string" ] }, "Application": [ { "ApplicationId": "af6d3d7a-a027-4ccd-848e-5f7524078f9a", "InquiryId": "7fd12126-5f01-4ada-91ee-e01a5c3eab84", "DateCreated": "2024-12-12T09:45:04.6665725+00:00", "LastUpdated": "2024-12-12T09:45:04.6665725+00:00", "ApplicationDateStarted": "2024-12-12T09:45:04.6665725+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-12-12T09:45:04.6665725+00:00", "ExpectedGradDateCode": "string", "ExpectedGradDate": "2024-12-12T09:45:04.6665725+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": "af6d3d7a-a027-4ccd-848e-5f7524078f9a", "InquiryId": "7fd12126-5f01-4ada-91ee-e01a5c3eab84", "DateCreated": "2024-12-12T09:45:04.6665725+00:00", "LastUpdated": "2024-12-12T09:45:04.6665725+00:00", "ApplicationDateStarted": "2024-12-12T09:45:04.6665725+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-12-12T09:45:04.6665725+00:00", "ExpectedGradDateCode": "string", "ExpectedGradDate": "2024-12-12T09:45:04.6665725+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-12-12T09:45:04.6665725+00:00", "UploadedBy": "string", "DocumentStatus": "string", "DocumentStatusId": 6, "ExpirationDate": "2024-12-12T09:45:04.6665725+00:00", "DueDate": "2024-12-12T09:45:04.6665725+00:00", "DocumentSource": "string", "ApprovalCode": "string", "UserId": "string", "DocumentFileName": "string", "TransactionId": "string", "TermStartCode": "string", "TermStart": "2024-12-12T09:45:04.6665725+00:00", "IsRevised": true, "ValidityDate": "2024-12-12T09:45:04.6665725+00:00", "VerityLeadId": 1, "ApplicationId": "1dbf08a7-de14-4129-babe-50a9d710a2ec", "ApplicationDocumentStatus": "string", "ApplicationDocumentStatusId": 1, "MimeType": "string" }, { "DocumentType": "string", "DocumentTypeId": 1, "FileName": "string", "FilePath": "string", "UploadedUtc": "2024-12-12T09:45:04.6665725+00:00", "UploadedBy": "string", "DocumentStatus": "string", "DocumentStatusId": 6, "ExpirationDate": "2024-12-12T09:45:04.6665725+00:00", "DueDate": "2024-12-12T09:45:04.6665725+00:00", "DocumentSource": "string", "ApprovalCode": "string", "UserId": "string", "DocumentFileName": "string", "TransactionId": "string", "TermStartCode": "string", "TermStart": "2024-12-12T09:45:04.6665725+00:00", "IsRevised": true, "ValidityDate": "2024-12-12T09:45:04.6665725+00:00", "VerityLeadId": 1, "ApplicationId": "1dbf08a7-de14-4129-babe-50a9d710a2ec", "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-12-12T09:45:04.6665725+00:00", "Ssn": "string" }, "Phones": [ { "IsPreferred": true, "ContactType": "string", "ContactTypeId": 1, "PhoneNumber": "string", "RawPhoneNumber": "string", "IsBad": true, "IsOld": true, "DoNotText": true, "DoNotCall": true }, { "IsPreferred": true, "ContactType": "string", "ContactTypeId": 1, "PhoneNumber": "string", "RawPhoneNumber": "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-12-12T09:45:04.6821959+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-12-12T09:45:04.6821959+00:00", "AttendedTo": "2024-12-12T09:45:04.6821959+00:00", "GraduationDate": "2024-12-12T09:45:04.6821959+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-12-12T09:45:04.6821959+00:00", "AttendedTo": "2024-12-12T09:45:04.6821959+00:00", "GraduationDate": "2024-12-12T09:45:04.6821959+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
}
|
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
}
|
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
}
|
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
}
|
Request | Response |
---|---|
application/json, text/json{ "Email": null, "Phone": "", "RawPhone": "", "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", "RawPhoneNumber": "string", "IsBad": true, "IsOld": true, "DoNotText": true, "DoNotCall": true }, { "IsPreferred": true, "ContactType": "string", "ContactTypeId": 1, "PhoneNumber": "string", "RawPhoneNumber": "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-12-12T09:45:05.0102809+00:00", "ExpectedGradDate": "string", "VerityLeadId": 39, "ExternalLeadId": "string" } |
application/json, text/json{ "Warnings": "string", "Message": "string", "Success": true, "Data": { "Email": null, "Phone": "", "RawPhone": "", "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", "RawPhoneNumber": "string", "IsBad": true, "IsOld": true, "DoNotText": true, "DoNotCall": true }, { "IsPreferred": true, "ContactType": "string", "ContactTypeId": 1, "PhoneNumber": "string", "RawPhoneNumber": "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-12-12T09:45:05.0259415+00:00", "ExpectedGradDate": "string", "VerityLeadId": 39, "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
}
|
Request | Response |
---|---|
application/json, text/json{ "StatusId": 1, "VerityLeadId": 2, "ExternalLeadId": "string" } |
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
}
|
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
}
|
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
}
|
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
}
|
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
}
|
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
}
|