{"info":{"_postman_id":"11ac03d6-46d7-4fa1-8c3a-749918c1ba67","name":"Pillar Pingtree API","description":"

Use this API to submit leads to the Pillar API for consideration.

\n

Authentication

\n

Your account manager will send you a secret key which needs to be added to the secret_key header of the request in order to authenticate the API request.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18637422","collectionId":"11ac03d6-46d7-4fa1-8c3a-749918c1ba67","publishedId":"VUr1FsMM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"000000"},"publishDate":"2022-09-15T10:23:31.000Z"},"item":[{"name":"Submit Lead","event":[{"listen":"prerequest","script":{"id":"2570626a-b7ee-46c6-8579-bffadb33ce33","exec":[""],"type":"text/javascript"}}],"id":"13c68a50-affc-48f5-890e-514f4a745912","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"public_key"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"product","value":"pillarMonitor","type":"text","description":"

(Required) Product name provided by your account manager

\n"},{"key":"leadSource","value":"pingyo","type":"text","description":"

(Required) Your unique source ID provided by your account manager

\n"},{"key":"leadTierPrice","value":"0.50","type":"text","description":"

(Required) The agreed tier price

\n"},{"key":"leadTierType","value":"CPL","type":"text","description":"

(Required) Tier type - CPL for per accept, CPF for per funded account

\n"},{"key":"leadUniqueIdentifier","value":"abc123","type":"text","description":"

(Required) The unique identifier for the lead in your system

\n"},{"key":"leadPublisherId","value":"192","type":"text","description":"

(Required) The source ID of your lead

\n"},{"key":"leadSubPublisherId","value":"","type":"text","description":"

An optional additional level for source ID

\n"},{"key":"leadCampaignId","value":"","type":"text","description":"

For specific campaigns - can be used in any way

\n"},{"key":"leadSubCampaignId","value":"","type":"text","description":"

For specific campaigns - can be used in any way

\n"},{"key":"leadCustomId1","value":"","type":"text","description":"

For any other information

\n"},{"key":"leadCustomId2","value":"","type":"text"},{"key":"leadCustomId3","value":"","type":"text"},{"key":"leadCustomId4","value":"","type":"text"},{"key":"leadCustomId5","value":"","type":"text"},{"key":"leadWebsiteUrl","value":"http://example.com","type":"text","description":"

The website where the lead applied

\n"},{"key":"leadReferrerUrl","value":"http://example.com","type":"text","description":"

The referring website

\n"},{"key":"leadUserAgent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36","type":"text","description":"

(Required) The full user agent of the lead

\n"},{"key":"leadIpAddress","value":"1.1.1.1","type":"text","description":"

(Required) The IP address of the lead

\n"},{"key":"firstName","value":"John","type":"text","description":"

(Required)

\n"},{"key":"lastName","value":"Smith","type":"text","description":"

(Required)

\n"},{"key":"emailAddress","value":"johnsdf1doe@gmail.com","type":"text","description":"

(Required)

\n"},{"key":"phoneNo","value":"+447123446181","type":"text","description":"

(Required) Must be a valid phone number in E.164 format

\n"},{"key":"dateOfBirth","value":"31/12/1963","type":"text","description":"

(Required) Date of birth in format dd/mm/yyyy

\n"},{"key":"address[current][subBuilding]","value":"Flat 3","type":"text","description":"

One of subBuilding, buildingNo, buildingName or streetName is required

\n"},{"key":"address[current][buildingNo]","value":"1a","type":"text"},{"key":"address[current][buildingName]","value":"Big House","type":"text"},{"key":"address[current][streetName]","value":"Baker Street","type":"text","description":"

(Required)

\n"},{"key":"address[current][city]","value":"London","type":"text","description":"

(Required)

\n"},{"key":"address[current][postCode]","value":"N1 1NA","type":"text","description":"

(Required)

\n"},{"key":"address[current][moveInDate]","value":"01/01/2021","type":"text"},{"key":"address[previous][subBuilding]","value":"","type":"text","disabled":true},{"key":"address[previous][buildingNo]","value":"","type":"text","disabled":true},{"key":"address[previous][buildingName]","value":"Big House","type":"text","disabled":true},{"key":"address[previous][streetName]","value":"Dukes Way","type":"text","description":"

(Required)

\n","disabled":true},{"key":"address[previous][city]","value":"London","type":"text","description":"

(Required)

\n","disabled":true},{"key":"address[previous][postCode]","value":"NW1 3DP","type":"text","description":"

(Required)

\n","disabled":true},{"key":"address[previous][moveInDate]","value":"01/01/2012","type":"text","disabled":true},{"key":"bankAccountNumber","value":"11111111","type":"text","description":"

(Required)

\n"},{"key":"bankSortCode","value":"309897","type":"text","description":"

(Required) Please remove any - from the sortcode

\n"},{"key":"usesOnlineBanking","value":"true","type":"text"},{"key":"marketingConsentEmails","value":"true","type":"text","description":"

(Required) Whether the lead has consented to email marketing

\n"},{"key":"marketingConsentSms","value":"true","type":"text","description":"

(Required)

\n"},{"key":"marketingConsentPhone","value":"true","type":"text","description":"

(Required)

\n"},{"key":"employmentStatus","value":"employedFullTime","type":"text","description":"

(Required) Must be one of the following values:\nemployedFullTime, employedPartTime, unemployed, disabilityBenefits, retired, selfEmployed, benefits

\n"},{"key":"employmentIndustry","value":"Finance","type":"text"},{"key":"employerName","value":"Tesco Bank","type":"text","description":"

(Required)

\n"},{"key":"employerStartDate","value":"31/01/2020","type":"text"},{"key":"homePhoneNumber","value":"+442037287649","type":"text"},{"key":"jobTitle","value":"Example Job","type":"text"},{"key":"loanAmount","value":"1200","type":"text","description":"

(Required)

\n"},{"key":"numberOfRecentLoans","value":"0","type":"text"},{"key":"nextPayDate","value":"31/05/2023","type":"text"},{"key":"netMonthlyIncome","value":"2100","type":"text","description":"

(Required)

\n"},{"key":"monthlyBenefitsAmount","value":"100","type":"text"},{"key":"monthlyPensionAmount","value":"0","type":"text"},{"key":"monthlyOtherIncomeAmount","value":"0","type":"text"},{"key":"payFrequency","value":"monthly","type":"text"},{"key":"residentialStatus","value":"homeowner","type":"text"},{"key":"loanTermInMonths","value":"0","type":"text"},{"key":"workPhoneNumber","value":"+448009187466","type":"text"},{"key":"monthlyMortgageRent","value":"200","type":"text"},{"key":"monthlyCredit","value":"0","type":"text"},{"key":"monthlyOther","value":"0","type":"text"},{"key":"monthlyTransport","value":"0","type":"text"},{"key":"monthlyFood","value":"0","type":"text"},{"key":"monthlyUtilities","value":"0","type":"text"},{"key":"monthlyAlcoholTobacco","value":"0","type":"text"},{"key":"monthlyHealthBeauty","value":"0","type":"text"},{"key":"monthlyRecreation","value":"0","type":"text"},{"key":"monthlyRestaurants","value":"0","type":"text"},{"key":"monthlyEducation","value":"0","type":"text"},{"key":"monthlyClothing","value":"0","type":"text"},{"key":"monthlyHouseholdGoods","value":"0","type":"text"},{"key":"monthlyEntertainment","value":"0","type":"text"},{"key":"monthlyTax","value":"0","type":"text"},{"key":"maritalStatus","value":"married","type":"text"},{"key":"financialDependents","value":"2","type":"text"},{"key":"householdAdults","value":"0","type":"text"},{"key":"householdAnnualIncome","value":"3000","type":"text"}]},"url":"https://staging.api.hellopillar.com/api/v1/pingtree/application","description":"

Our API will accept either x-www-form-urlencoded values or raw json.

\n

Addresses

\n

The addresses are parsed as json objects like this:

\n
address: {\n    current: {\n        subBuilding: 'Flat 1'\n        ...\n    },\n    previous: {\n        subBuilding: 'Flat 1'\n        ...\n    }\n}\n

But if using x-www-form-urlencoded you can pass each value in as an individual value like this: address[current][subBuilding]

\n

Responses

\n

Example reject request:

\n
{\n    \"data\": {\n        \"result\": \"REJECTED\",\n        \"reason\": \"DUPLICATE\",\n        \"redirectUrl\": null\n    },\n    \"meta\": {\n        \"code\": 200,\n        \"message\": \"Lead rejected as a duplicate\"\n    },\n    \"logId\": \"JKNSejFKuEG4N1SL4Hsm77a4ICQ3raliLbX4YQMR3zJxLVp05cnQgxiiW4f2qad6\"\n}\n

Example accept request:

\n
{\n    \"data\": {\n        \"result\": \"ACCEPTED\",\n        \"reason\": null,\n        \"redirectUrl\": \"https://affinitech-web-onboarding.firebaseapp.com/lead/accept/FQfItQ1TlBhSDB1AMjZ8\"\n    },\n    \"meta\": {\n        \"code\": 200,\n        \"message\": \"Lead accepted, please redirect to the redirectUrl\"\n    },\n    \"logId\": \"Tz7F0zUvG4g6y4nWRehbWwfv563shcijz4FsrpOKLfDrFIig9YbyFoF55fUSAj3l\"\n}\n

Example validation error:

\n
{\n    \"data\": null,\n    \"meta\": {\n        \"code\": 400,\n        \"message\": \"emailAddress must be a valid email\"\n    },\n    \"logId\": \"o71Y3dbpJSycJYeVb6wVRcp1GXyuA6x9pBxNHknV5f0XVZUaoo3AN6XonthDxgPv\"\n}\n
","urlObject":{"protocol":"https","path":["api","v1","pingtree","application"],"host":["staging","api","hellopillar","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"13c68a50-affc-48f5-890e-514f4a745912"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"public_key"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"66850b7d-2070-43a8-b54f-f30de0588bf0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c3fb377e-f3b0-4a33-bf4c-397230558480","type":"text/javascript","exec":[""]}}]}