Service Catalog

API Documentation

June 2023

Verity Service List

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

Authorization

GET api/Authorization

api/Authorization

Request

Login
NameDescriptionTypeAdditional information
username

string

None.

password

string

None.

application/json, text/json

{
  "username": "string",
  "password": "string"
}

Response

ActionResult

None.




GET connector/Authorization/GetAuthorizationToken

connector/Authorization/GetAuthorizationToken

Request

Login
NameDescriptionTypeAdditional information
username

string

None.

password

string

None.

application/json, text/json

{
  "username": "string",
  "password": "string"
}

Response

ActionResult

None.




Leads

POST connector/Leads/UpdateExternalLeadId

connector/Leads/UpdateExternalLeadId

Request

ExternalLeadModel
NameDescriptionTypeAdditional information
VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

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

Response

ResponseModelOfExternalLeadModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

ExternalLeadModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "VerityLeadId": 1,
    "ExternalLeadId": "string"
  }
}



POST connector/Leads/UpdateOptout

connector/Leads/UpdateOptout

Request

OptoutLeadModel
NameDescriptionTypeAdditional information
VerityLeadId

integer

None.

ExternalLeadId

string

None.

Emails

Collection of string

None.

Phones

Collection of string

None.

Text

Collection of string

None.

application/json, text/json

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

Response

ResponseModelOfOptoutLeadModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

OptoutLeadModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "VerityLeadId": 1,
    "ExternalLeadId": "string",
    "Emails": [
      "string",
      "string"
    ],
    "Phones": [
      "string",
      "string"
    ],
    "Text": [
      "string",
      "string"
    ]
  }
}



POST connector/Leads/UpdateOptin

connector/Leads/UpdateOptin

Request

OptinLeadModel
NameDescriptionTypeAdditional information
VerityLeadId

integer

None.

ExternalLeadId

string

None.

Emails

Collection of string

None.

Phones

Collection of string

None.

Text

Collection of string

None.

application/json, text/json

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

Response

ResponseModelOfOptinLeadModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

OptinLeadModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "VerityLeadId": 1,
    "ExternalLeadId": "string",
    "Emails": [
      "string",
      "string"
    ],
    "Phones": [
      "string",
      "string"
    ],
    "Text": [
      "string",
      "string"
    ]
  }
}



POST connector/Leads/UpdateLeadStatus

connector/Leads/UpdateLeadStatus

Request

UpdateLeadStatusModel
NameDescriptionTypeAdditional information
StatusId

integer

None.

VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

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

Response

ResponseModelOfUpdateLeadStatusModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

UpdateLeadStatusModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "StatusId": 1,
    "VerityLeadId": 2,
    "ExternalLeadId": "string"
  }
}



POST connector/Leads/UpdateLeadPersonalData

connector/Leads/UpdateLeadPersonalData

Request

UpdateLeadPersonalModel
NameDescriptionTypeAdditional information
Email

string

None.

Phone

string

None.

PhoneContactType

string

None.

PostalCode

string

None.

Address

string

None.

City

string

None.

State

string

None.

Province

string

None.

Country

string

None.

Emails

Collection of EmailInfo

None.

Phones

Collection of PhoneInfo

None.

FirstName

string

None.

LastName

string

None.

MiddleName

string

None.

FormerName

string

None.

NickName

string

None.

ProfessionalTitle

string

None.

Salutation

string

None.

Gender

string

None.

BirthDate

string

None.

EducationLevel

string

None.

EmploymentStatus

string

None.

VeteranStatus

string

None.

Citizenship

string

None.

Nationality

string

None.

Ethnicity

string

None.

PreferredLanguage

string

None.

GradYear

string

None.

LeadSource

string

None.

LeadStatus

string

None.

Program

string

None.

ProgramOfEnrollment

Collection of string

None.

TermStart

string

None.

Campus

string

None.

AdmissionAdvisor

string

None.

LeadType

string

None.

StudentAccountsAdvisor

string

None.

FinancialAidAdvisor

string

None.

CareerServicesAdvisor

string

None.

LeadDateTime

date

None.

ExpectedGradDate

string

None.

VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

{
  "Email": null,
  "Phone": "",
  "PhoneContactType": "string",
  "PostalCode": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "Province": "string",
  "Country": "string",
  "Emails": [],
  "Phones": [],
  "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": "2023-06-03T08:47:50.0218546+00:00",
  "ExpectedGradDate": "string",
  "VerityLeadId": 38,
  "ExternalLeadId": "string"
}

Response

ResponseModelWithWarningsOfUpdateLeadPersonalModel
NameDescriptionTypeAdditional information
Warnings

string

None.

Message

string

None.

Success

boolean

None.

Data

UpdateLeadPersonalModel

None.

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": [],
    "Phones": [],
    "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": "2023-06-03T08:47:50.0687274+00:00",
    "ExpectedGradDate": "string",
    "VerityLeadId": 38,
    "ExternalLeadId": "string"
  }
}



POST connector/Leads/GetLeadPersonalData

connector/Leads/GetLeadPersonalData

Request

ExternalLeadModel
NameDescriptionTypeAdditional information
VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

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

Response

ResponseModelOfLeadPersonalDataModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

LeadPersonalDataModel

None.

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"
  }
}



POST connector/Leads/AddNewLead

connector/Leads/AddNewLead

Request

AddNewLeadModel
NameDescriptionTypeAdditional information
ExternalLeadId

string

None.

FirstName

string

Required

LastName

string

Required

MiddleName

string

None.

FormerName

string

None.

NickName

string

None.

PostalCode

string

None.

Address

string

None.

City

string

None.

State

string

None.

Province

string

None.

Country

string

None.

Emails

Collection of EmailInfo

None.

Phones

Collection of PhoneInfo

None.

LeadSource

string

None.

LeadStatus

string

None.

Program

string

Required

ProgramOfEnrollment

Collection of string

None.

TermStart

string

None.

Campus

string

Required

AdmissionAdvisor

string

Required

StudentAccountsAdvisor

string

None.

FinancialAidAdvisor

string

None.

CareerServicesAdvisor

string

None.

LeadDateTime

date

None.

ExpectedGradDate

string

None.

LeadType

string

None.

Gender

string

None.

BirthDate

string

None.

EducationLevel

string

None.

EmploymentStatus

string

None.

VeteranStatus

string

None.

Citizenship

string

None.

Nationality

string

None.

Ethnicity

string

None.

PreferredLanguage

string

None.

GradYear

string

None.

ProfessionalTitle

string

None.

Salutation

string

None.

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": [],
  "Phones": [],
  "LeadSource": "string",
  "LeadStatus": "string",
  "Program": "string",
  "ProgramOfEnrollment": [
    "string",
    "string"
  ],
  "TermStart": "string",
  "Campus": "string",
  "AdmissionAdvisor": "string",
  "StudentAccountsAdvisor": "string",
  "FinancialAidAdvisor": "string",
  "CareerServicesAdvisor": "string",
  "LeadDateTime": "2023-06-03T08:47:50.1156015+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"
}

Response

ResponseModelOfAddNewLeadModelResponse
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

AddNewLeadModelResponse

None.

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": [],
    "Phones": [],
    "LeadSource": "string",
    "LeadStatus": "string",
    "Program": "string",
    "ProgramOfEnrollment": [
      "string",
      "string"
    ],
    "TermStart": "string",
    "Campus": "string",
    "AdmissionAdvisor": "string",
    "StudentAccountsAdvisor": "string",
    "FinancialAidAdvisor": "string",
    "CareerServicesAdvisor": "string",
    "LeadDateTime": "2023-06-03T08:47:50.1312284+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"
  }
}



POST connector/Leads/SaveReference

connector/Leads/SaveReference

Request

SaveReferenceInfo
NameDescriptionTypeAdditional information
VerityLeadId

integer

None.

ExternalLeadId

string

None.

FirstName

string

String length: inclusive between 0 and 50

MiddleName

string

String length: inclusive between 0 and 50

LastName

string

String length: inclusive between 0 and 50

PhoneNumber

string

String length: inclusive between 0 and 30

EmailAddress

string

String length: inclusive between 0 and 80

Relationship

string

String length: inclusive between 0 and 100

Address

string

String length: inclusive between 0 and 100

City

string

String length: inclusive between 0 and 50

Province

string

String length: inclusive between 0 and 100

PostalCode

string

String length: inclusive between 0 and 50

State

string

String length: inclusive between 0 and 2

StateId

integer

None.

Country

string

String length: inclusive between 0 and 100

CountryId

integer

None.

IsParentSigner

boolean

None.

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
}

Response

ResponseModelOfSaveReferenceInfoResponse
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

SaveReferenceInfoResponse

None.

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
  }
}



POST connector/Leads/GetApplicantData

connector/Leads/GetApplicantData

Request

ApplicantDataSearchModel
NameDescriptionTypeAdditional information
ApplicationId

globally unique identifier

None.

ApplicationIds

Collection of globally unique identifier

None.

VerityLeadId

integer

None.

ExternalLeadId

string

None.

IncludeInfo

Collection of ApplicantInfoType

None.

PageNumber

integer

None.

PageSize

integer

None.

application/json, text/json

{
  "ApplicationId": "e0d351b2-9e46-407e-8488-fcf2e8f02663",
  "ApplicationIds": [
    "7bde50a9-cb1e-44f5-ba7f-e78731449b84",
    "508b1919-84c1-432b-bfd6-b2aee20a3ddc"
  ],
  "VerityLeadId": 1,
  "ExternalLeadId": "string",
  "IncludeInfo": [
    0,
    0
  ],
  "PageNumber": 3,
  "PageSize": 4
}

Response

ResponseModelOfApplicantDataModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

ApplicantDataModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "Inquiry": {
      "School": "string",
      "LeadSourceCategory": "string",
      "LeadStatusCategory": "string",
      "InquiryDate": "2023-06-03T08:47:50.2249749+00:00",
      "LeadSource": "string",
      "LeadSourceId": 1,
      "LeadStatus": "string",
      "LeadStatusId": 1,
      "ProgramOfInterest": "string",
      "ProgramOfInterestId": 1,
      "TermStart": "string",
      "TermStartDate": "2023-06-03T08:47:50.2249749+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": "2023-06-03T08:47:50.2249749+00:00",
      "LeadType": "string",
      "LeadTypeId": 1,
      "ProgramOfEnrollment": [
        "string",
        "string"
      ]
    },
    "Application": [
      {
        "ApplicationId": "55f711bc-eab6-42e6-9a4a-47df0b1f6e3a",
        "InquiryId": "1beae3ce-5d1e-4cb1-b09f-0f0f9dcf2d6f",
        "DateCreated": "2023-06-03T08:47:50.2249749+00:00",
        "LastUpdated": "2023-06-03T08:47:50.2249749+00:00",
        "ApplicationDateStarted": "2023-06-03T08:47:50.2249749+00:00",
        "Status": "string",
        "StatusId": 1,
        "School": "string",
        "Campus": "string",
        "CampusId": 1,
        "ProgramOfEnrollment": "string",
        "ProgramOfEnrollmentId": 1,
        "Shift": "string",
        "ShiftId": 1,
        "StartDateCode": "string",
        "StartDate": "2023-06-03T08:47:50.2249749+00:00",
        "ExpectedGradDateCode": "string",
        "ExpectedGradDate": "2023-06-03T08:47:50.2249749+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": "55f711bc-eab6-42e6-9a4a-47df0b1f6e3a",
        "InquiryId": "1beae3ce-5d1e-4cb1-b09f-0f0f9dcf2d6f",
        "DateCreated": "2023-06-03T08:47:50.2249749+00:00",
        "LastUpdated": "2023-06-03T08:47:50.2249749+00:00",
        "ApplicationDateStarted": "2023-06-03T08:47:50.2249749+00:00",
        "Status": "string",
        "StatusId": 1,
        "School": "string",
        "Campus": "string",
        "CampusId": 1,
        "ProgramOfEnrollment": "string",
        "ProgramOfEnrollmentId": 1,
        "Shift": "string",
        "ShiftId": 1,
        "StartDateCode": "string",
        "StartDate": "2023-06-03T08:47:50.2249749+00:00",
        "ExpectedGradDateCode": "string",
        "ExpectedGradDate": "2023-06-03T08:47:50.2249749+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": "2023-06-03T08:47:50.2249749+00:00",
        "UploadedBy": "string",
        "DocumentStatus": "string",
        "DocumentStatusId": 1,
        "ExpirationDate": "2023-06-03T08:47:50.2249749+00:00",
        "DueDate": "2023-06-03T08:47:50.2249749+00:00",
        "DocumentSource": "string",
        "ApprovalCode": "string",
        "UserId": "string",
        "DocumentFileName": "string",
        "TransactionId": "string",
        "TermStartCode": "string",
        "TermStart": "2023-06-03T08:47:50.2249749+00:00",
        "IsRevised": true,
        "ValidityDate": "2023-06-03T08:47:50.2249749+00:00",
        "VerityLeadId": 1,
        "ApplicationId": "92e99a78-072e-4a23-b9d4-51dee7bf01cc",
        "ApplicationDocumentStatus": "string",
        "ApplicationDocumentStatusId": 1,
        "MimeType": "string"
      },
      {
        "DocumentType": "string",
        "DocumentTypeId": 1,
        "FileName": "string",
        "FilePath": "string",
        "UploadedUtc": "2023-06-03T08:47:50.2249749+00:00",
        "UploadedBy": "string",
        "DocumentStatus": "string",
        "DocumentStatusId": 1,
        "ExpirationDate": "2023-06-03T08:47:50.2249749+00:00",
        "DueDate": "2023-06-03T08:47:50.2249749+00:00",
        "DocumentSource": "string",
        "ApprovalCode": "string",
        "UserId": "string",
        "DocumentFileName": "string",
        "TransactionId": "string",
        "TermStartCode": "string",
        "TermStart": "2023-06-03T08:47:50.2249749+00:00",
        "IsRevised": true,
        "ValidityDate": "2023-06-03T08:47:50.2249749+00:00",
        "VerityLeadId": 1,
        "ApplicationId": "92e99a78-072e-4a23-b9d4-51dee7bf01cc",
        "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": "2023-06-03T08:47:50.2249749+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": "2023-06-03T08:47:50.2406034+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": "2023-06-03T08:47:50.2406034+00:00",
        "AttendedTo": "2023-06-03T08:47:50.2406034+00:00",
        "GraduationDate": "2023-06-03T08:47:50.2406034+00:00",
        "GraduationYear": 1,
        "Degree": "string",
        "DegreeId": 1,
        "Address": "string",
        "City": "string",
        "State": "string",
        "StateId": 1,
        "Province": "string",
        "PostalCode": "string"
      },
      {
        "College": "string",
        "AttendedFrom": "2023-06-03T08:47:50.2406034+00:00",
        "AttendedTo": "2023-06-03T08:47:50.2406034+00:00",
        "GraduationDate": "2023-06-03T08:47:50.2406034+00:00",
        "GraduationYear": 1,
        "Degree": "string",
        "DegreeId": 1,
        "Address": "string",
        "City": "string",
        "State": "string",
        "StateId": 1,
        "Province": "string",
        "PostalCode": "string"
      }
    ],
    "VerityLeadId": 1,
    "ExternalLeadId": "string"
  }
}



List

POST connector/List/GetListNames

connector/List/GetListNames

Request

Response

ResponseModelOfListOfListModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

Collection of ListModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": [
    {
      "Id": 1,
      "Name": "string"
    },
    {
      "Id": 1,
      "Name": "string"
    }
  ]
}



POST connector/List/GetListValues

connector/List/GetListValues

Request

ListModel
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

application/json, text/json

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

Response

ResponseModelOfListOfListModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

Collection of ListModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": [
    {
      "Id": 1,
      "Name": "string"
    },
    {
      "Id": 1,
      "Name": "string"
    }
  ]
}



POST connector/List/UpdateCustomFields

connector/List/UpdateCustomFields

Request

CustomFieldUpdateModel
NameDescriptionTypeAdditional information
VerityLeadId

integer

None.

ExternalLeadId

string

None.

CustomFields

Collection of CustomFieldModel

None.

application/json, text/json

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

Response

ResponseModelOfCustomFieldUpdateModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

CustomFieldUpdateModel

None.

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"
      }
    ]
  }
}



Documents

POST connector/Documents/SaveDocumentType

connector/Documents/SaveDocumentType

Request

DocumentTypeModel
NameDescriptionTypeAdditional information
CategoryCode

string

Required

CategoryName

string

Required

TypeCode

string

Required

TypeName

string

Required

ValidityDuration

integer

Required

application/json, text/json

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

Response

ResponseModelOfDocumentTypeModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

DocumentTypeModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "CategoryCode": "string",
    "CategoryName": "string",
    "TypeCode": "string",
    "TypeName": "string",
    "ValidityDuration": 1
  }
}



POST connector/Documents/AddStudentDocument

connector/Documents/AddStudentDocument

Request

StudentDocumentAddModel
NameDescriptionTypeAdditional information
VerityLeadId

integer

None.

ExternalLeadId

string

None.

DocumentStatus

string

Required

ExpirationDate

date

None.

DueDate

date

None.

DocumentSource

string

None.

ApprovalCode

string

None.

User

string

Required

DocumentType

string

Required

DocumentFileName

string

Required

Term

string

None.

ValidityDate

date

None.

FileStream

HttpPostedFileMultipart

None.

Base64File

string

None.

application/json, text/json

{
  "VerityLeadId": 1,
  "ExternalLeadId": "string",
  "DocumentStatus": "string",
  "ExpirationDate": "2023-06-03T08:47:50.3979235+00:00",
  "DueDate": "2023-06-03T08:47:50.3979235+00:00",
  "DocumentSource": "string",
  "ApprovalCode": "string",
  "User": "string",
  "DocumentType": "string",
  "DocumentFileName": "string",
  "Term": "string",
  "ValidityDate": "2023-06-03T08:47:50.3979235+00:00",
  "FileStream": null,
  "Base64File": "string"
}

Response

ResponseModelOfStudentDocumentSaveModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

StudentDocumentSaveModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "UploadedDocumentId": 1,
    "TransactionId": "string",
    "VerityLeadId": 3,
    "ExternalLeadId": "string",
    "DocumentStatus": "string",
    "ExpirationDate": "2023-06-03T08:47:50.429219+00:00",
    "DueDate": "2023-06-03T08:47:50.429219+00:00",
    "DocumentSource": "string",
    "ApprovalCode": "string",
    "User": "string",
    "DocumentType": "string",
    "DocumentFileName": "string",
    "Term": "string",
    "ValidityDate": "2023-06-03T08:47:50.429219+00:00",
    "FileStream": null,
    "Base64File": "string"
  }
}



POST connector/Documents/UpdateStudentDocument

connector/Documents/UpdateStudentDocument

Request

StudentDocumentUpdateModel
NameDescriptionTypeAdditional information
TransactionId

string

Required

VerityLeadId

integer

None.

ExternalLeadId

string

None.

DocumentStatus

string

Required

ExpirationDate

date

None.

DueDate

date

None.

DocumentSource

string

None.

ApprovalCode

string

None.

User

string

Required

DocumentType

string

Required

DocumentFileName

string

Required

Term

string

None.

ValidityDate

date

None.

FileStream

HttpPostedFileMultipart

None.

Base64File

string

None.

application/json, text/json

{
  "TransactionId": "string",
  "VerityLeadId": 2,
  "ExternalLeadId": "string",
  "DocumentStatus": "string",
  "ExpirationDate": "2023-06-03T08:47:50.44484+00:00",
  "DueDate": "2023-06-03T08:47:50.44484+00:00",
  "DocumentSource": "string",
  "ApprovalCode": "string",
  "User": "string",
  "DocumentType": "string",
  "DocumentFileName": "string",
  "Term": "string",
  "ValidityDate": "2023-06-03T08:47:50.44484+00:00",
  "FileStream": null,
  "Base64File": "string"
}

Response

ResponseModelOfStudentDocumentSaveModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

StudentDocumentSaveModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "UploadedDocumentId": 1,
    "TransactionId": "string",
    "VerityLeadId": 3,
    "ExternalLeadId": "string",
    "DocumentStatus": "string",
    "ExpirationDate": "2023-06-03T08:47:50.44484+00:00",
    "DueDate": "2023-06-03T08:47:50.44484+00:00",
    "DocumentSource": "string",
    "ApprovalCode": "string",
    "User": "string",
    "DocumentType": "string",
    "DocumentFileName": "string",
    "Term": "string",
    "ValidityDate": "2023-06-03T08:47:50.44484+00:00",
    "FileStream": null,
    "Base64File": "string"
  }
}



POST connector/Documents/DeleteStudentDocument

connector/Documents/DeleteStudentDocument

Request

GetStudentDocumentModel
NameDescriptionTypeAdditional information
TransactionId

string

Required

VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

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

Response

ResponseModelOfGetStudentDocumentModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

GetStudentDocumentModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "TransactionId": "string",
    "VerityLeadId": 2,
    "ExternalLeadId": "string"
  }
}



POST connector/Documents/GetDocument

connector/Documents/GetDocument

Request

GetStudentDocumentModel
NameDescriptionTypeAdditional information
TransactionId

string

Required

VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

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

Response

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.




POST connector/Documents/GetDocumentBase64

connector/Documents/GetDocumentBase64

Request

GetStudentDocumentModel
NameDescriptionTypeAdditional information
TransactionId

string

Required

VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

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

Response

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.




POST Documents/SaveDocumentType

Documents/SaveDocumentType

Request

DocumentTypeModel
NameDescriptionTypeAdditional information
CategoryCode

string

Required

CategoryName

string

Required

TypeCode

string

Required

TypeName

string

Required

ValidityDuration

integer

Required

application/json, text/json

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

Response

ResponseModelOfDocumentTypeModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

DocumentTypeModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "CategoryCode": "string",
    "CategoryName": "string",
    "TypeCode": "string",
    "TypeName": "string",
    "ValidityDuration": 1
  }
}



POST Documents/AddStudentDocument

Documents/AddStudentDocument

Request

StudentDocumentAddModel
NameDescriptionTypeAdditional information
VerityLeadId

integer

None.

ExternalLeadId

string

None.

DocumentStatus

string

Required

ExpirationDate

date

None.

DueDate

date

None.

DocumentSource

string

None.

ApprovalCode

string

None.

User

string

Required

DocumentType

string

Required

DocumentFileName

string

Required

Term

string

None.

ValidityDate

date

None.

FileStream

HttpPostedFileMultipart

None.

Base64File

string

None.

application/json, text/json

{
  "VerityLeadId": 1,
  "ExternalLeadId": "string",
  "DocumentStatus": "string",
  "ExpirationDate": "2023-06-03T08:47:50.4760912+00:00",
  "DueDate": "2023-06-03T08:47:50.4760912+00:00",
  "DocumentSource": "string",
  "ApprovalCode": "string",
  "User": "string",
  "DocumentType": "string",
  "DocumentFileName": "string",
  "Term": "string",
  "ValidityDate": "2023-06-03T08:47:50.4760912+00:00",
  "FileStream": null,
  "Base64File": "string"
}

Response

ResponseModelOfStudentDocumentSaveModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

StudentDocumentSaveModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "UploadedDocumentId": 1,
    "TransactionId": "string",
    "VerityLeadId": 3,
    "ExternalLeadId": "string",
    "DocumentStatus": "string",
    "ExpirationDate": "2023-06-03T08:47:50.4760912+00:00",
    "DueDate": "2023-06-03T08:47:50.4760912+00:00",
    "DocumentSource": "string",
    "ApprovalCode": "string",
    "User": "string",
    "DocumentType": "string",
    "DocumentFileName": "string",
    "Term": "string",
    "ValidityDate": "2023-06-03T08:47:50.4760912+00:00",
    "FileStream": null,
    "Base64File": "string"
  }
}



POST Documents/UpdateStudentDocument

Documents/UpdateStudentDocument

Request

StudentDocumentUpdateModel
NameDescriptionTypeAdditional information
TransactionId

string

Required

VerityLeadId

integer

None.

ExternalLeadId

string

None.

DocumentStatus

string

Required

ExpirationDate

date

None.

DueDate

date

None.

DocumentSource

string

None.

ApprovalCode

string

None.

User

string

Required

DocumentType

string

Required

DocumentFileName

string

Required

Term

string

None.

ValidityDate

date

None.

FileStream

HttpPostedFileMultipart

None.

Base64File

string

None.

application/json, text/json

{
  "TransactionId": "string",
  "VerityLeadId": 2,
  "ExternalLeadId": "string",
  "DocumentStatus": "string",
  "ExpirationDate": "2023-06-03T08:47:50.4917016+00:00",
  "DueDate": "2023-06-03T08:47:50.4917016+00:00",
  "DocumentSource": "string",
  "ApprovalCode": "string",
  "User": "string",
  "DocumentType": "string",
  "DocumentFileName": "string",
  "Term": "string",
  "ValidityDate": "2023-06-03T08:47:50.4917016+00:00",
  "FileStream": null,
  "Base64File": "string"
}

Response

ResponseModelOfStudentDocumentSaveModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

StudentDocumentSaveModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "UploadedDocumentId": 1,
    "TransactionId": "string",
    "VerityLeadId": 3,
    "ExternalLeadId": "string",
    "DocumentStatus": "string",
    "ExpirationDate": "2023-06-03T08:47:50.4917016+00:00",
    "DueDate": "2023-06-03T08:47:50.4917016+00:00",
    "DocumentSource": "string",
    "ApprovalCode": "string",
    "User": "string",
    "DocumentType": "string",
    "DocumentFileName": "string",
    "Term": "string",
    "ValidityDate": "2023-06-03T08:47:50.4917016+00:00",
    "FileStream": null,
    "Base64File": "string"
  }
}



POST Documents/DeleteStudentDocument

Documents/DeleteStudentDocument

Request

GetStudentDocumentModel
NameDescriptionTypeAdditional information
TransactionId

string

Required

VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

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

Response

ResponseModelOfGetStudentDocumentModel
NameDescriptionTypeAdditional information
Message

string

None.

Success

boolean

None.

Data

GetStudentDocumentModel

None.

application/json, text/json

{
  "Message": "string",
  "Success": true,
  "Data": {
    "TransactionId": "string",
    "VerityLeadId": 2,
    "ExternalLeadId": "string"
  }
}



POST Documents/GetDocument

Documents/GetDocument

Request

GetStudentDocumentModel
NameDescriptionTypeAdditional information
TransactionId

string

Required

VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

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

Response

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.




POST Documents/GetDocumentBase64

Documents/GetDocumentBase64

Request

GetStudentDocumentModel
NameDescriptionTypeAdditional information
TransactionId

string

Required

VerityLeadId

integer

None.

ExternalLeadId

string

None.

application/json, text/json

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

Response

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.