CIFAS UK 048

About the service

CIFAS UK 048 enables members to search a large amounts of case data associated with acts of fraudulent conduct filed as cases to the National Fraud Database (NFD). This RESTful API allows you to pass in search criteria to be checked against this repository and to access the details of the matching cases.

Product Code: W2_DATA_CIFAS_UK_048

Request

Query Data

The following QueryData properties pertain to this service.

At least one of the fields must be present.

Property Name	Type	Length	Optional/Mandatory	Notes
Forename	String	25	Optional
Surname	String	25	Optional
CompanyName	String	2-70	Optional
CompanyNumber	String	8	Optional
DayOfBirth	Integer	2	Optional
MonthOfBirth	Integer	2	Optional
YearOfBirth	Integer	4	Optional
Email	String	x	Optional	Regex format: `^[^@\s]+@[^@\s]+\.[^@\s]+$`
HomePhoneNumber	String	4	Optional	`[0-9]{1,20}$`
PhoneNumber	String	16	Optional	`[0-9]{1,20}$`
WorkPhoneNumber	String	4	Optional	`[0-9]{1,20}$`
EmployerPhoneNumber	String	4	Optional	`[0-9]{1,20}$`
CompanyPhoneNumber	String	20	Optional	`[0-9]{1,20}`
NationalInsuranceNumber	String	9	Optional
VehicleIdentificationNumber	String	50	Optional
VehicleRegistrationNumber	String	10	Optional
DeviceId	String	50	Optional
IP	String	7-15	Optional	The IPv4 Address.
SortCode	String	6	Optional	`[0-9]{6}`
AccountNumber	String	8	Optional	`[0-9]{8}`
CardNumber	String	19	Optional	`[0-9]{1,19}`
VATNumber	String	7-14	Optional	`(uk?GB)[0-9A-Za-z]{5-12}`
Flat	String	20	Optional	`[^\|]{1,20}`
HouseName	String	20	Optional	`[^\|]{1,20}`
HouseNumber	String	10	Optional	`[^\|]{1,10}`
Street	String	30	Optional	`[^\|]{1,30}$`
City	String	20	Optional	`[^\|]{1,20}`
Postcode	String	5-8	Optional	`[^\|]{5,8}`

Example Request

json

"Data": {
    "Forename": "Brandon",
    "Surname": "Marsh",
    "DayOfBirth": 30,
    "MonthOfBirth": 6,
    "YearOfBirth": 1942,
    "HouseNumber": "74",
    "Street": "Guildford Rd",
    "Postcode": "RH19 6EG"
}

Response

The following shows the basic schema for the CIFASUk048Result result.

Example Response

json

"CIFASUk048Result": {
	"searchResult": {
		"matchedCasesCount": 3,
		"matches": [
			{
				"caseId": 8698203,
				"owningMember": {
					"referenceCode": "547",
					"description": "NFIB"
				},
				"managingMember": {
					"referenceCode": "547",
					"description": "NFIB"
				},
				"caseType": {
					"referenceCode": "AFR",
					"description": "False Application"
				},
				"product": {
					"referenceCode": "AFCH",
					"description": "Asset Fin - Contract Hire"
				},
				"supplyDate": "2022-09-06T00:00:00",
				"applicationDate": "0001-01-01T00:00:00",
				"claimDate": "0001-01-01T00:00:00",
				"filingReasons": [
					{
						"referenceCode": "FDM",
						"description": "Docs - false"
					}
				],
				"deliveryChannel": {
					"referenceCode": "BRO",
					"description": "Broker"
				},
				"facility": {
					"referenceCode": "NGR",
					"description": "Not granted"
				},
				"subjects": [
					{
						"role": {
							"referenceCode": "APP",
							"description": "Applicant"
						},
						"roleQualifier": {
							"referenceCode": "TI4",
							"description": "True identity with falsehoods (04)"
						},
						"firstName": "brian",
						"surname": "james",
						"birthDate": "1970-03-04T00:00:00",
						"employmentType": {
							"referenceCode": "NTS",
							"description": "Not specified"
						},
						"emailAddress": "[email protected]",
						"addresses": [
							{
								"addressType": {
									"referenceCode": "CA",
									"description": "Current on application"
								},
								"flatOrUnit": "1G The Old Brick Wor",
								"houseName": "Poole Industrial Est",
								"streetName": "Higher Poole",
								"district": "Poole",
								"town": "Wellington",
								"county": "Somerset",
								"postcode": "TA21 9HW",
								"timeAtAddress": {
									"format": {}
								}
							}
						],
						"financeDetails": [],
						"documents": [
							{
								"copyAvailable": {
									"referenceCode": "N",
									"description": "Copy not available"
								},
								"documentType": {
									"referenceCode": "ALE",
									"description": "Accountant (etc.) letter"
								},
								"documentQualifier": {
									"referenceCode": "UNS",
									"description": "Unspecified"
								},
								"nationality": {},
								"reference": "kp"
							}
						],
						"withholdSubjectAccess": false
					}
				],
				"matchingRules": [
					{
						"referenceCode": "C02F",
						"description": "Exact email match, or a sub domain match within the defined list of known unique sub domains"
					}
				]
			},
			{
				"caseId": 8690870,
				"owningMember": {
					"referenceCode": "547",
					"description": "NFIB"
				},
				"managingMember": {
					"referenceCode": "547",
					"description": "NFIB"
				},
				"caseType": {
					"referenceCode": "AFR",
					"description": "False Application"
				},
				"product": {
					"referenceCode": "AFCH",
					"description": "Asset Fin - Contract Hire"
				},
				"supplyDate": "2020-12-01T00:00:00",
				"applicationDate": "0001-01-01T00:00:00",
				"claimDate": "0001-01-01T00:00:00",
				"filingReasons": [
					{
						"referenceCode": "BOG",
						"description": "Bogus Organisation"
					}
				],
				"deliveryChannel": {
					"referenceCode": "COM",
					"description": "Combination"
				},
				"facility": {
					"referenceCode": "NGR",
					"description": "Not granted"
				},
				"subjects": [
					{
						"role": {
							"referenceCode": "APP",
							"description": "Applicant"
						},
						"roleQualifier": {
							"referenceCode": "TI4",
							"description": "True identity with falsehoods (04)"
						},
						"firstName": "der",
						"surname": "smith",
						"birthDate": "1980-10-12T00:00:00",
						"employmentType": {
							"referenceCode": "NTS",
							"description": "Not specified"
						},
						"emailAddress": "[email protected]",
						"addresses": [
							{
								"addressType": {
									"referenceCode": "CA",
									"description": "Current on application"
								},
								"houseNumber": "75",
								"streetName": "Quakers Road",
								"town": "Bristol",
								"county": "Gloucestershire",
								"postcode": "BS16 6NH",
								"timeAtAddress": {
									"format": {}
								}
							}
						],
						"financeDetails": [
							{
								"type": "BankOrBuildingSocietyAccount",
								"relevance": {
									"referenceCode": "PNC",
									"description": "Provided but not checked"
								},
								"timeWithInstitution": {
									"format": {}
								}
							}
						],
						"documents": [],
						"withholdSubjectAccess": false
					}
				],
				"matchingRules": [
					{
						"referenceCode": "C02F",
						"description": "Exact email match, or a sub domain match within the defined list of known unique sub domains"
					}
				]
			},
			{
				"caseId": 8686897,
				"owningMember": {
					"referenceCode": "547",
					"description": "NFIB"
				},
				"managingMember": {
					"referenceCode": "547",
					"description": "NFIB"
				},
				"caseType": {
					"referenceCode": "AFR",
					"description": "False Application"
				},
				"product": {
					"referenceCode": "AFCH",
					"description": "Asset Fin - Contract Hire"
				},
				"supplyDate": "2020-01-31T00:00:00",
				"applicationDate": "2020-01-30T00:00:00",
				"claimDate": "0001-01-01T00:00:00",
				"filingReasons": [
					{
						"referenceCode": "BCO",
						"description": "Bogus company"
					}
				],
				"deliveryChannel": {
					"referenceCode": "MAI",
					"description": "Mail"
				},
				"facility": {
					"referenceCode": "NGR",
					"description": "Not granted"
				},
				"subjects": [
					{
						"role": {
							"referenceCode": "APP",
							"description": "Applicant"
						},
						"roleQualifier": {
							"referenceCode": "TI4",
							"description": "True identity with falsehoods (04)"
						},
						"firstName": "Lee",
						"surname": "Fraud",
						"birthDate": "0001-01-01T00:00:00",
						"employmentType": {
							"referenceCode": "NTS",
							"description": "Not specified"
						},
						"emailAddress": "[email protected]",
						"addresses": [
							{
								"addressType": {
									"referenceCode": "CA",
									"description": "Current on application"
								},
								"houseNumber": "4A",
								"streetName": "Kings Terrace",
								"town": "Emsworth",
								"county": "Hampshire",
								"postcode": "PO10 7AA",
								"timeAtAddress": {
									"format": {}
								}
							}
						],
						"financeDetails": [],
						"documents": [
							{
								"copyAvailable": {
									"referenceCode": "N",
									"description": "Copy not available"
								},
								"documentType": {
									"referenceCode": "ACC",
									"description": "Accounts"
								},
								"documentQualifier": {
									"referenceCode": "UNS",
									"description": "Unspecified"
								},
								"nationality": {},
								"reference": "Lee 123"
							}
						],
						"withholdSubjectAccess": false
					}
				],
				"matchingRules": [
					{
						"referenceCode": "C01C",
						"description": "Both first name and surname used with same address"
					},
					{
						"referenceCode": "C02F",
						"description": "Exact email match, or a sub domain match within the defined list of known unique sub domains"
					},
					{
						"referenceCode": "C05A",
						"description": "Same surname and address"
					}
				]
			}
		],
		"alerts": {
			"caseLink": {
				"caseLinkStatus": "Level1And2",
				"reference": "0A4EFE4F-3B12-48B0-8B92-7087D5786DC7"
			}
		}
	}
}

Response Breakdown

As with all other bundle services the response is separated into two sections: Service specific outputs and the summarized results (Service transaction).

The summarized results section is explained here: Service transaction information

Below is some information about service specific outputs.

Search Result

Under cifasUk048Result you will find searchResult. The following is the schema breakdown of the possible fields.

The top level result will include:

Property Name	Type	Description
MatchedCasesCount	Integer	The number of CIFAS Cases that generated a match for the search.
Matches	Array of `CIFASCase`	An array of CIFAS Cases that were returned from the search.
Alerts	`CIFASAlert`	Any alerts generated from the CIFAS search.
ProcessingErrors	Array of String	An array of strings containing any processing errors encountered during the search.

ReferenceValue

Property Name	Type
ReferenceCode	String
Description	String

TimeAt

Property Name	Type
Format	`ReferenceValue`
Year	Integer
Year	Integer

CIFASCase

Property Name	Type	Description
CaseId	Integer	The CIFAS cases unique identifier.
OwningMember	`ReferenceValue`
ManagingMember	`ReferenceValue`
CaseType	`ReferenceValue`
Product	`ReferenceValue`
SupplyDate	DateTime	The date the case was filed on FIND
ApplicationDate	DateTime	The date of the application supplied with the case
ClaimDate	DateTime	The date of the claim supplied with the case
FilingReasons	Array of `ReferenceValue`
DeliveryChannel	`ReferenceValue`
IpAddress	String
DeviceId	String
Facility	`ReferenceValue`
Subjects	Array of `CIFASSubject`
MatchingRules	Array of `ReferenceValue`

CIFASSubject

Property Name	Type
Role	`ReferenceValue`
RoleQualifier	`ReferenceValue`
FirstName	String
MiddleNames	String
Surname	String
BirthDate	DateTime
NationalInsuranceNumber	String
EmploymentType	`ReferenceValue`
HomeTelephoneNumber	String
MobileTelephoneNumber	String
WorkTelephoneNumber	String
EmployerTelephoneNumber	String
EmailAddress	String
VehicleRegistrationNumber	String
VehicleIdentificationNumber	String
CompanyName	String
CompanyNumber	String
VatNumber	String
WebsiteAddress	String
Addresses	Array of `CIFASSubjectAddress`
FinanceDetails	Array of `CIFASFinanceInformation`
Documents	Array of `CIFASDocumentInformation`
WithholdSubjectAccess	Boolean

CIFASSubjectAddress

Property Name	Type
AddressType	`ReferenceValue`
FlatOrUnit	String
HouseName	String
HouseNumber	String
StreetName	String
District	String
Town	String
County	String
Postcode	String
TimeAtAddress	`TimeAt`

CIFASFinanceInformation

Property Name	Type
Type	String
Relevance	`ReferenceValue`
TimeWithInstitution	`TimeAt`

CIFASDocumentInformation

Property Name	Type
CopyAvailable	`ReferenceValue`
DocumentType	`ReferenceValue`
DocumentQualifier	`ReferenceValue`
Nationality	`ReferenceValue`
Reference	String

Sandbox

Sandbox mode can be used to test the service. By setting the following query option and sending some the below query data we will return a pre-configured response without actually calling our suppliers.

Query options for Sandbox

json

"options": {
    "sandbox": "true"
}

Sandbox cases

These are the sandbox options for these service. Learn about our Sandbox here

Click on a sandbox case to view the request and response

CIFAS UK 048 ​

About the service ​

Request ​

Query Data ​

Example Request ​

Response ​

Example Response ​

Response Breakdown ​

Search Result ​

ReferenceValue ​

TimeAt ​

CIFASCase ​

CIFASSubject ​

CIFASSubjectAddress ​

CIFASFinanceInformation ​

CIFASDocumentInformation ​

Sandbox ​

Sandbox cases

CIFAS UK 048

About the service

Request

Query Data

Example Request

Response

Example Response

Response Breakdown

Search Result

ReferenceValue

TimeAt

CIFASCase

CIFASSubject

CIFASSubjectAddress

CIFASFinanceInformation

CIFASDocumentInformation

Sandbox