Creditsafe Connect API Documentation

Submits a GB Consumer or AML Search

Submits a GB Consumer or AML depending on the Product provided. Validates criteria for each individual search before submitting, and may return a list of error strings instead.

SecuritybearerToken

Request

Request Body schema: application/json

Select the relevant tab for the request body for one of the products AML, AMLMultiBureau or Consumer.

NOTE:' If a previous address is used in addition to current the postCode becomes required.

One of:

Search parameters for AML product

	object (Connect.Identity.AmlCommonSearchCriteria) Person search criteria
	object Contains information relevant for anti-money laundering (AML) identity verification, including contact details, banking information, and documentation status.
products	Array of strings Enter `AML` for this product search

Responses

200

Success

400

Bad Request

401

Invalid Token

403

Access Forbidden

500

Server Error

post/localSolutions/GB/identitysearch

Request samples

application/json

{"common": {"person": {"currentName": {"title": "",
"forename": "Doe",
"otherNames": "",
"surname": "John",
"suffix": ""
},
"previousName"": {"title": null,
"forename": null,
"otherName"": null,
"surname": null,
"suffix": null
},
"dateOfBirth": "1991-04-05",
"gender": "",
"addresses": {"current": {"abodeNo": "",
"buildingNo": "110",
"buildingName": "",
"street": "Pierhead Street",
"subStreet": "",
"city": "Cardiff",
"postCode": "CF10 4DQ",
"organisation": "",
"subBuilding": "",
"district": ""
},
"previous1": {"abodeNo": "",
"buildingNo": "",
"buildingName": "",
"street": "",
"subStreet": "",
"city": "",
"postCode": "",
"organisation": "",
"subBuilding": "",
"district": ""
},
"previous2": {"abodeNo": "",
"buildingNo": "",
"buildingName": "",
"street": "",
"subStreet": "",
"city": "",
"postCode": "",
"organisation": "",
"subBuilding": "",
"district": ""
}
}
},
"reference": "24680"
},
"IdAml": {"LandlineNumber": "",
"ExDirectory": false,
"Documents": null
},
"products": ["AML"
],
"uniqueId": null
}

Response samples

application/json

{"correlationId": "a2093b41-b7fe-4973-8eba-78f3627168a7",
"uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
"input": {"uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
"common": {"person": {"currentName": {"title": "Miss",
"forename": "Anne",
"otherNames": "",
"surname": "Delta",
"suffix": ""
},
"previousName": {"title": "Miss",
"forename": "Anne",
"otherNames": "",
"surname": "Delta",
"suffix": ""
},
"dateOfBirth": "1948-06-04T00:00:00",
"gender": "Female",
"addresses": {"current": {"buildingNo": "7",
"buildingName": "",
"street": "Twelve Acre Crescent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2010-05-13T00:00:00"
},
"previous1": {"buildingNo": "7",
"buildingName": "",
"street": "Twelve Acre Crescent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2010-05-13T00:00:00",
"endDate": "2010-05-13T00:00:00"
},
"previous2": {"buildingNo": "7",
"buildingName": "",
"street": "Twelve Acre Crescent",
"city": "Barton-Le-Willows",
"postCode": "X9 8JD",
"startDate": "2010-05-13T00:00:00",
"endDate": "2010-05-13T00:00:00"
}
}
},
"customerId": 106828872,
"userId": 101686746,
"reference": "Test - Consumer Search"
},
"consumer": {"reason": "QuotationSearch",
"thirdPartyOptIn": false,
"addressLink": false,
"associateLink": false
},
"idAml": {"isAMLMultiBureau": true
},
"products": ["Consumer"
]
},
"common": {"customerId": 106828872,
"userId": 101686746,
"uniqueId": "43d27878fa4b4e74b336a6c1b21d690d",
"searchText": "Miss Anne Delta (4/06/1948) X9 8JD",
"reference": "Test - Consumer Search",
"searchTime": "024-04-23T11:19:35.180004+00:00"
},
"consumerResult": {"applicant1Report": {"reportTitle": "MS SARAH HAWKINS",
"reportType": "Individual report",
"summary": {"matchedData": [{"dateOfBirth": "1974-07-07T00:00:00",
"name": "MS SARAH HAWKINS",
"addressLine1": "6 HAZELTREE COURT",
"addressLine2": "",
"addressLine3": "TROWBRIDGE",
"addressLine4": "BA99 7SZ",
"isSelected": true
}
],
"matchLevel": "Individual report",
"noticesOfCorrections": true,
"totalDisputes": 0,
"confirmedAddress": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"residency": [{"address": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"currentAddress": true,
"id": 1,
"message": "Individual confirmed using the Electoral Roll."
},
{"address": "28 SUGAR TERRACE, BRIGHTON, BN99 2TR",
"currentAddress": false,
"id": 2,
"message": "Individual confirmed using a previous Electoral Roll."
},
{"address": "13 FISKERTON LANE, BRIGHTON, BN99 5BX",
"currentAddress": false,
"id": 2,
"message": "Individual confirmed using credit data.",
"undeclaredAddressType": 3
}
],
"creditSearchesAtCurrentAddress": {"numberInLast3Months": 3,
"numberInLast12Months": 12,
"totalinLast3Months": 3000
},
"insolvencyAtAddress": {"restricted": false,
"currentlyInsolvent": true,
"totalDischarged": 4
},
"links": {"undeclaredAddressCount": 1,
"undeclaredAliasCount": 1,
"undeclaredAssociatesCount": 1,
"undeclaredAddressSearchedCount": 1,
"undeclaredAddressUnsearchedCount": 0
},
"judgements": {"totalActive": 2,
"totalSatisfied": 10,
"totalActiveAmount": 28675
},
"totalCifas": 0,
"rtr": true,
"impairedCreditHistory": {"impairedCredit": true,
"secured": false,
"unsecured": false,
"judgement": true,
"individualVoluntaryAgreement": true,
"bankruptcy": true
},
"thirdParty": {"alertDecision": 3,
"alertReview": 2,
"householdOverride": 1
},
"address": {"paf": true,
"rollingRoll": true,
"message": "11"
},
"cardData": {"totalMinPayments12Months": 2,
"totalMinPayments36Months": 2,
"totalCashAdvance12Months": 400,
"totalCashAdvance36Months": 1200
}
},
"score": {"band": 2,
"version": "G1",
"score": 542
},
"address": {"address": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"isCurrent": true,
"residents": [{"matchType": "House Match",
"name": "MR MICHAEL WATTS",
"duration": "P52M",
"startDate": "2016-09-01T00:00:00",
"endDate": "2020-09-01T00:00:00",
"electoralRollValid": true,
"electoralRollHistory": [{ }
]
}
]
},
"previousAddress1": {"address": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"isCurrent": true,
"residents": [{"matchType": "House Match",
"name": "MR MICHAEL WATTS",
"duration": "P52M",
"startDate": "2016-09-01T00:00:00",
"endDate": "2020-09-01T00:00:00",
"electoralRollValid": true,
"electoralRollHistory": [{ }
]
}
],
"undeclaredAddressType": "Undeclared previous Address Link"
},
"previousAddress2": {"address": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"isCurrent": true,
"residents": [{"matchType": "House Match",
"name": "MR MICHAEL WATTS",
"duration": "P52M",
"startDate": "2016-09-01T00:00:00",
"endDate": "2020-09-01T00:00:00",
"electoralRollValid": true,
"electoralRollHistory": [{ }
]
}
],
"undeclaredAddressType": "Undeclared previous Address Link"
},
"links": {"undeclaredAddresses": [{"undeclaredAddress": "21 JAMES COURT, BATH, BA99 3UP",
"undeclaredAddressTo": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"lastConfirmation": "2004-01-01T00:00:00",
"earliestConfirmation": "2004-01-01T00:00:00",
"supplierDetails": {"supplierName": "Building Society Name",
"supplierType": "Building Society"
}
}
],
"aliases": [{"declared": false,
"name": "MS SARAH HAWKINS",
"alias": "MS SARAH WATTS",
"creationDate": "2021-01-01T00:00:00",
"lastConfirmation": "2021-01-01T00:00:00",
"supplierDetails": {"supplierName": "Building Society Name",
"supplierType": "Building Society"
}
}
],
"associates": [{"navigationLinkId": "testid",
"name": "MR MICHAEL WATTS",
"creationDate": "2021-01-01T00:00:00",
"lastConfirmation": "2021-01-01T00:00:00",
"supplierDetails": {"supplierName": "Building Society Name",
"supplierType": "Building Society"
},
"declared": false
}
]
},
"insolvencies": [{"address": {"address": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"isCurrent": true,
"undeclaredAddressType": ""
},
"court": "Bath County Court",
"name": "MS SARAH HAWKINS",
"orderDate": "2016-06-17T00:00:00",
"orderTypeCode": "BO",
"orderType": "Bankruptcy Order",
"status": "Active",
"statusCode": "A",
"tradingName": "",
"lineOfBusiness": "Unknown",
"amount": 10000,
"caseYear": 2016,
"caseRef": "TEST2",
"dateOfBirth": "1974-07-07T00:00:00",
"restriction": {"type": "Bankruptcy Restriction Order",
"startDate": "2016-06-17T00:00:00",
"endDate": "2025-08-15T00:00:00"
}
}
],
"judgements": [{"name": "MS SARAH HAWKINS",
"address": {"address": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"isCurrent": true
},
"addressCurrent": false,
"dateOfBirth": "1974-07-07T00:00:00",
"judgementDate": "2019-03-05T00:00:00",
"amount": 21196,
"status": "Active",
"court": "Bath County Court",
"courtType": "County Court Judgment",
"caseNumber": "BCT11081",
"satisfiedDate": "2016-11-29T00:00:00"
}
],
"history": [{"address": {"address": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"isCurrent": false
},
"balance": 10000,
"dateOfBirth": "1974-07-07T00:00:00",
"startDate": "2020-01-01T00:00:00",
"endDate": "2021-01-01T00:00:00",
"jointApplication": true,
"name": "MS SARAH HAWKINS",
"tpOptIn": true,
"ownSearch": false,
"reason": "Address Verification",
"reference": "Some reference",
"supplierReference": "{XXXX-XXXX-XXX}",
"subsequentEnquiry": false,
"term": 12,
"transient": true,
"creditType": "Hire Purchase",
"userName": "placeholder",
"searchDate": "2021-01-05T00:00:00",
"searchUnitName": "Creditsafe Business Solutions",
"searchOrganisationName": "Creditsafe Business Solutions",
"searchOrganisationType": "Finance House"
}
],
"notices": [{"name": "MS SARAH HAWKINS",
"address": {"address": "6 HAZELTREE COURT, TROWBRIDGE, BA99 7SZ",
"isCurrent": true
},
"reference": "12356",
"comment": "I, Sarah Hawkins, am a test record and have no identity. Please do not lend me money as I do not exist.",
"dateRaised": "2019-12-14T00:00:00"
}
],
"demographics": {"cameoCode": "01C",
"cameoInvestorCode": "56",
"cameoIncomeCode": "36",
"cameoUnemploymentCode": "09",
"cameoPropertyCode": "06",
"cameoFinanceCode": "66",
"cameoFinanceGroup": "6",
"cameoIncomeGroup": "3",
"cameoInvestmentGroup": "5",
"cameoGroup": "01",
"ageComposition": {"description": "string",
"label": "Score:",
"score": "96.42 / 100"
},
"economicActivityComposition": {"description": "string",
"label": "Score:",
"score": "83.98 / 100"
},
"hasValues": true,
"householdComposition": {"description": "string",
"label": "Score:",
"score": "8.03 / 100"
},
"lifestageComposition": {"description": "string",
"label": "Score:",
"score": "12.25 / 100"
},
"mortgageComposition": {"description": "string",
"label": "Score:",
"score": "4.17 / 100"
},
"neighbourhoodDefinition": {"financeGroup": "Above Average Risk",
"financeGroupHouseholdPerc": "18.41",
"income": "Young Managers & Professionals",
"incomeGroup": "Many households with an income of between £50 - £75K",
"investorHouseholdPerc": "19.73",
"investorIndex": "38 - 76",
"riskFactor": "20% - 36%",
"uk": "Urban Living Professional Singles & Couples",
"ukGroup": "Affluent Singles & Couples In Exclusive Urban Neighbourhoods",
"ukHouseholdPerc": "3.47",
"description": "string"
},
"occupationComposition": {"description": "string",
"label": "Score:",
"score": "88.57 / 100"
},
"propertyComposition": {"activity": 168,
"averageDetachedPropertyValue": "£213630",
"averageDetachedPropertyValueDescription": "string",
"averageDetachedPropertyIndex": 120,
"averageFlatPropertyValue": "£74000",
"averageFlatPropertyIndex": 100,
"averageHouseAge": "16+",
"averageSemiDetachedPropertyValue": "£130636",
"averageSemiDetachedPropertyValueDescription": "string",
"averageSemiDetachedPropertyIndex": 80,
"averageTerracePropertyValue": "£106269",
"averageTerracePropertyValueDescription": "string",
"averageTerracePropertyIndex": 1158,
"councilTaxBand": "E",
"councilTaxBandDescription": "string",
"householdDensity": "2000.12 per square kilometre",
"locationType": "a small town",
"nationalAverageHousePrice": "£161361",
"nationalAverageHousePriceAboveOrBelow": "below",
"nationalAverageHousePriceDifference": "increased",
"nationalAverageHousePriceIndex": 349996,
"averageFlatPropertyValueDescription": "string"
},
"shareholderComposition": {"averageInvestments": "0.31",
"averageInvestmentsDescription": "string",
"averageInvestmentsLabel": "Investments:",
"averageShareholders": "0.71",
"averageShareholdersDescription": "string",
"averageShareholdersLabel": "Shareholders:",
"averageShares": "-0.02",
"averageSharesDescription": "string",
"averageSharesLabel": "Shares:",
"averageValue": "-0.01",
"averageValueDescription": "string",
"averageValueLabel": "Value:",
"proportionOfHouseholdsWithShares": "-0.08",
"proportionOfHouseholdsWithSharesDescription": "string",
"proportionOfHouseholdsWithSharesLabel": "Households:",
"socialClassComposition": {"description": "string",
"label": "Score:",
"score": "58.27 / 100"
},
"tenureComposition": {"description": "string",
"label": "Score:",
"score": "97.12 / 100"
},
"unemploymentComposition": {"maleLongTermUnemploymentDescription": "string",
"maleLongTermUnemploymentLabel": "Male Long-Term:",
"unemploymentAmong18to24YearOlds": "0.00",
"unemploymentAmong18to24YearOldsDescription": "string",
"unemploymentAmong18to24YearOldsLabel": "18 to 24 Year Olds:",
"unemploymentAmong25to39YearOlds": "15.99",
"unemploymentAmong25to39YearOldsDescription": "string",
"unemploymentAmong25to39YearOldsLabel": "25 to 39 Year Olds:",
"unemploymentAmongThoseAged40andOlder": "15.99",
"unemploymentAmongThoseAged40andOlderDescription": "string",
"unemploymentAmongThoseAged40andOlderLabel": "40 and Older:",
"unemploymentScoreLabel": "Score:",
"unemploymentScoreDescription": "string",
"unemploymentScore": "77.36",
"maleLongTermUnemploymentScore": "5.33"
}
}
},
"share": {"summary": {"accountCount": 7,
"activeAccountCount": 6,
"settledAccountCount": 1,
"accountsOpenedLast6Months": 2,
"delinquentAccountsLast12Months": 0,
"defaultsLast12MonthsCount": 0,
"defaultsLast36MonthsCount": 0
},
"accounts": [{"supplierDetails": {"supplierType": "Current Account",
"supplierTypeCode": "CA"
},
"history": [{"yearAndMonth": null,
"balance": null,
"limit": null,
"status": null,
"statusCode": null,
"paymentStatus": null,
"paymentStatusCode": null
}
],
"holderDetails": {"name": "Sarah Hawkins",
"address": {"address": null,
"isCurrent": null,
"undeclaredAddressType": null
},
"dateOfBirth": "1974-07-07T00:00:00",
"status": "Normal",
"startDate": "2013-04-12T00:00:00",
"endDate": "2018-01-01T00:00:00"
},
"details": {"accountNumber": "123456",
"accountSuffix": "Unknown",
"joint": false,
"status": "Normal",
"dateUpdated": "2013-07-31T00:00:00",
"currencyCode": "GBP",
"balance": 0,
"limit": 500,
"openingBalance": 22,
"paymentStartDate": "2013-04-12T00:00:00",
"accountStartDate": "2013-04-12T00:00:00",
"regularPayment": 50,
"repaymentPeriod": 12,
"lumpPayment": 0,
"repaymentFrequencyCode": "M",
"repaymentFrequency": "Monthly"
}
}
],
"indebtedness": {"totalActiveBalance": 81751,
"totalBalancedRevolvingCreditAndBudget": 6893,
"balanceToLimitRatio": 28,
"totalLimit": 24550,
"totalBalancedLoansOrInstallmentCredit": 10552,
"totalBalancedMortgageAccounts": 64306
}
},
"shareAvailable": true
},
"dateAndTimeOfReport": "2021-01-01T12:00:48",
"gaugeVersion": "G1",
"reason": "Quotation Search",
"success": false,
"supplierId": "{AAAAE42F-92E5-4ED9-B322-XXXXXXXXXXXX}",
"creditsIncurred": 1
},
"errors": { }
}

➔ Next to Resolves a picklist against a given UniqueId