Refer, Document Required (Non-PSD2)
Learn about our end-to-end refer customer onboarding journey. A refer journey is used when an applicant must submit documents for onboarding. Our eKYC verification processes can be layered into this journey as required for PSD2 compliance.
createApplication
The applicant enters their personal information into a blank application form and the request is sent, creating the application.
verifyPhoneNumber
Check whether the applicant’s phone number exists. If this is false, it is still possible to continue with the acquisition journey. This step requires a third-party integration.
Please note that steps verifyPhoneNumber, verifyEmailAddress and checkEligibility steps happen in parallel.
verifyEmailAddress
Check whether the applicant’s email address exists. If this is false, it is still possible to continue with the acquisition journey. This step requires a third-party integration.
Please note that steps verifyPhoneNumber, verifyEmailAddress and checkEligibility steps happen in parallel.
checkEligibility
Complete a soft check on the applicant's eligibility once they have created an application. The response returned will define the next step in the customer journey, for this journey, the state is defined below. Information is passed at this point to your credit decision engine.
Please note that steps verifyPhoneNumber, verifyEmailAddress and checkEligibility steps happen in parallel.
SSO Widget - Create credentials
Create log-in credentials to save and return your application journey, repeat spend and set up your e-servicing account.
renderDocument
Retrieve and display an applicant’s Important Customer Information, Pre-contract Credit Information, and the Credit Agreement in HTML or PDF. This endpoint is called once per document that is retrieved.
applicationUpdate
Update information about an applicant that has been captured during their application. This can be information from the application form or other information such as marketing preferences, credit limit increases and more.
signature
An applicant will tick their e-signature and submitting this will confirm they have accepted the terms of their agreement. The response returned will define the next step in the customer journey, for this journey, the state is defined below.
requestDecision
Perform a hard check on the applicant’s credit history and use the returned information in your credit decision engine. for this journey, the state is defined below.
Doc Upload Widget
Upload evidence requested by an underwriter for their assessment on case decisions.
Awaiting review
The customer has provided documents for onboarding, these documents are awaiting review.
Request Example
Request
1curl --request POST \
2 --url https://dapi.stg-newdaytechnology.net/acquisition/v2/applications \
3 --header 'Device-Endpoint: SOME_STRING_VALUE' \
4 --header 'Device-Type: SOME_STRING_VALUE' \
5 --header 'Merchant-Id: SOME_STRING_VALUE' \
6 --header 'Session-Id: SOME_STRING_VALUE' \
7 --header 'content-type: application/json' \
8 --data '{"productId":"string","customerRef":"string","brand":"string","merchantId":"string","externalRef":"string","title":"mr","firstName":"string","middleNames":"string","lastName":"string","dateOfBirth":"2019-08-24T14:15:22Z","email":"strings","mobile":"string","homePhone":"string","currentAddress":{"flatNumber":"string","houseName":"string","houseNumber":"string","street":"string","district":"string","town":"string","postcode":"string","county":"string","country":"string","movedIn":"2019-08-24T14:15:22Z","timeAtAddress":"string"},"previousAddressOverseas":true,"previousAddress":{"flatNumber":"string","houseName":"string","houseNumber":"string","street":"string","district":"string","town":"string","postcode":"string","county":"string","country":"string","movedIn":"2019-08-24T14:15:22Z","timeAtAddress":"string"},"grossAnnualIncome":0.1,"otherHouseholdIncome":0.1,"accommodationCosts":0.1,"expenditureDependants":0.1,"expenditureEducationCost":0.1,"expenditureUtilitiesCost":0.1,"expenditureOtherCost":0.1,"financialSituation":"decline","dependants":7,"employmentStatus":"fullTime","employmentStartDate":"2019-08-24T14:15:22Z","employerName":"string","residentialStatus":"ownerOccupier","maritalStatus":"married","statementPreference":"eStatements","marketingConsent":{"email":true,"post":true,"sms":true,"phone":true,"online":true},"basketAmount":0.1,"basketRef":"string","loanAmount":0.1,"loanTerm":0,"dcmScore":9999,"marketingRef":"stringstringstringst","verificationId":"stringstri","applicantReferralId":"string","openBankingUserId":"stringstri","source":"other","channel":"Aggregators","kycEvidences":[{"type":"mobilePhoneOtp","status":"authenticated","creationDate":"2019-08-24T14:15:22Z"}],"assistedTransferData":{"flag":"1","urn":"string","primaryRecordIdentifier":"string","accountOpenDate":"2019-08-24T14:15:22Z","customerNameChanged":true,"customerConsentSubmitted":true,"customerDateOfBirthChanged":true,"customerAddressChanged":true,"physicalIdCheckCompleted":true,"physicalIdCheckDateCompleted":"2019-08-24T14:15:22Z","alternativeOtpCompleted":true,"pennyDropSkipped":true,"balanceTransferRequested":true,"consentCreditFraudChecks":true,"instoreCustomerApplicationConsent":true,"accessibilityRequirements":"braille","existingCreditLimit":0.1,"entryMethod":"openDoor","thirdPartyBusinessUnits":[{"businessUnit":"string","timeStamp":"2019-08-24T14:15:22Z"}],"longTermBTOffer":"0"},"employeeId":"string","storeId":"string","cashWithdrawalRequired":true,"cashWithdrawalAmount":0.1,"moneyTransferAmount":0.1,"balanceTransferRequired":true,"balanceTransferAmount":0.1,"chosenPaymentDayOfMonth":1,"checkoutIndicator":true,"nationalityDetails":{"nationality":"str","ukArrivalDate":"string","visaStatus":"string","visaExpiryDate":"string"},"merchantInformation":{"shippingAddress":{"title":"mr","firstName":"string","middleNames":"string","lastName":"string","address1":"string","address2":"string","town":"string","postcode":"string","county":"string","country":"string"}},"creditLimitIncreasePreference":"automatic","occupation":"string"}'Response Example
Response
JSON
1{
2 "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
3 "customerRef": "string",
4 "modifiedDate": "2019-08-24T14:15:22Z"
5}