Request Information

URI Parameters

None.

Body Parameters

The .

LeadCreationRequest
NameDescriptionTypeAdditional information
callbackUrl

Gets or sets the callback URL.

 string

None.
corporatePartnerCode

Gets or sets the corporate partner code.

 string

None.
organization

Gets or sets the organization.

 string

None.
subjectProperty

Gets or sets the subject property.

 SubjectProperty

None.
transactionId

Gets or sets the transaction identifier (external ID).

 string

None.
borrowers

Gets or sets the list of borrowers.

 Collection of Borrower

None.

Request Formats

application/json, text/json

Sample: 
{
  "callbackUrl": "sample String 1",
  "corporatePartnerCode": "sample String 2",
  "organization": "sample String 3",
  "subjectProperty": {
    "address": {
      "city": "sample String 1",
      "countyFipsId": "sample String 2",
      "state": "sample String 3",
      "street": "sample String 4",
      "unitNumber": "sample String 5",
      "zipCode": "sample String 6"
    }
  },
  "transactionId": "sample String 4",
  "borrowers": [
    {
      "email": "sample String 1",
      "firstName": "sample String 2",
      "homePhone": "sample String 3",
      "isPrimaryContact": true,
      "lastName": "sample String 5",
      "middleName": "sample String 6",
      "mobilePhone": "sample String 7",
      "workPhone": "sample String 8"
    },
    {
      "email": "sample String 1",
      "firstName": "sample String 2",
      "homePhone": "sample String 3",
      "isPrimaryContact": true,
      "lastName": "sample String 5",
      "middleName": "sample String 6",
      "mobilePhone": "sample String 7",
      "workPhone": "sample String 8"
    }
  ]
}

text/html

Sample: 
{"callbackUrl":"sample String 1","corporatePartnerCode":"sample String 2","organization":"sample String 3","subjectProperty":{"address":{"city":"sample String 1","countyFipsId":"sample String 2","state":"sample String 3","street":"sample String 4","unitNumber":"sample String 5","zipCode":"sample String 6"}},"transactionId":"sample String 4","borrowers":[{"email":"sample String 1","firstName":"sample String 2","homePhone":"sample String 3","isPrimaryContact":true,"lastName":"sample String 5","middleName":"sample String 6","mobilePhone":"sample String 7","workPhone":"sample String 8"},{"email":"sample String 1","firstName":"sample String 2","homePhone":"sample String 3","isPrimaryContact":true,"lastName":"sample String 5","middleName":"sample String 6","mobilePhone":"sample String 7","workPhone":"sample String 8"}]}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The response.

LeadCreationResponse
NameDescriptionTypeAdditional information
appId

Gets or sets the application identifier.

 integer

None.
message

Gets or sets the message.

 string

None.
status

Gets or sets the HTTP status code.

 HttpStatusCode

None.
transactionId

Gets or sets the transaction identifier (external ID).

 string

None.
errors

Gets or sets the list of errors.

 Collection of LeadCreationError

None.

Response Formats

application/json, text/json

Sample: 
{
  "appId": 1,
  "message": "sample String 1",
  "status": 100,
  "transactionId": "sample String 2",
  "errors": [
    {
      "code": "sample String 1",
      "detail": "sample String 2"
    },
    {
      "code": "sample String 1",
      "detail": "sample String 2"
    }
  ]
}

text/html

Sample: 
{"appId":1,"message":"sample String 1","status":100,"transactionId":"sample String 2","errors":[{"code":"sample String 1","detail":"sample String 2"},{"code":"sample String 1","detail":"sample String 2"}]}