UK Residential Check

Overview
The Global KYC Citizen Check API for Great Britain provides an automated way to verify the personal and residential details of UK citizens. This API is designed to confirm the accuracy of provided information against authoritative databases, aiding in identity verification and compliance with regulatory standards.
Usecase
This API is particularly valuable for:
Financial Services: Banks and other financial institutions can use this API to verify identity details during account opening, loan applications, or customer record updates.
Employment Background Checks: Companies performing pre-employment screening can verify the personal details of potential hires.
Government Services: Government agencies can verify citizen details for program eligibility or document issuance.
API Details
Request Body
PreProduction
Production
curl --location 'https://api-preproduction.signzy.app/api/v3/global-kyc/verify/gb/citizen-check' \
--header 'Authorization: <----Auth Token---->' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "JOHN",
    "lastName": "Doe",
    "dateOfBirth": "1967-06-15",
    "addressLine1": "7 Cromhall Close",
    "addressLine3": "Fareham",
    "addressLine5": "AA1 XX0",
    "emailAddress": "[email protected]",
    "consent": true
}'
curl --location 'https://api-preproduction.signzy.app/api/v3/global-kyc/verify/gb/citizen-check' \
--header 'Authorization: <----Auth Token---->' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "JOHN",
    "lastName": "Doe",
    "dateOfBirth": "1967-06-15",
    "addressLine1": "7 Cromhall Close",
    "addressLine3": "Fareham",
    "addressLine5": "AA1 XX0",
    "emailAddress": "DZ3@Email.com",
    "consent": true
}'
﻿
Request Body Parameters
Parameter
Type
Description
Required
firstName
String
First name of the individual
Yes
lastName
String
Last name of the individual
Yes
dateOfBirth
Date
Date of birth (format: YYYY-MM-DD)
Yes
addressLine1
String
Primary residential address line
Yes
addressLine3
String
City or locality part of the address
Yes
addressLine5
String
Postal code
Yes
emailAddress
String
Email address of the individual
Yes
consent
Boolean
Consent from the individual for verification
Yes
Successful Response
{ 
"result": {
   "verificationResult": {
     "firstName": true,
     "lastName": true,
     "dateOfBirth": true,
     "address" : true,
     "addressScore" : 0.63
   },
   "verificationStatus" : "Verified/Not Verified/Partially Verified",
   "reason" : "reason" : "All elements verified/DOB not verified/NID not verified/Address not verified"
 }
}

{ 
"result": {
   "verificationResult": {
     "firstName": true,
     "lastName": true,
     "dateOfBirth": true,
     "address" : true,
     "addressScore" : 0.63
   },
   "verificationStatus" : "Verified/Not Verified/Partially Verified",
   "reason" : "reason" : "All elements verified/DOB not verified/NID not verified/Address not verified"
 }
}
﻿
Response Body Parameter
Parameter
Type
Description
verificationResult
Object
Container for detailed results of the verification.
firstName
Boolean
Result of the first name verification.
lastName
Boolean
Result of the last name verification.
dateOfBirth
Boolean
Result of the date of birth verification.
address
Boolean
Result of the address verification.
addressScore
Float
Numerical score (0-1) representing the address match quality.
verificationStatus
String
Overall status of the verification ("Verified" or "Not Verified").
reason
String
Explanation of the verification results.
Error Code and Response Mapping
400 (Bad Request)
401(Unauthorized)
403 (Forbidden)
500 (Internal Server Error)
409(Upstream Down
{
  "error": {
     "name": "error",
     "message": "Internal server error",
     "status": 500,
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": 500
  }
}
{
  "error": {
     "name": "error",
     "message": "Internal server error",
     "status": 500,
     "reason": "ERROR",
     "type": "Bad Request",
     "statusCode": 500
  }
}
﻿
Field
Type
Description
name
string
Text displayed on the screen explaining error type.
reason
string
Reason for the error.
status
number
HTTP status code.
message
string
Error message indicating an upstream error.
type
string
Error type.
statusCode
number
Status code representing the error scenario.
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
﻿

Parameter	Type	Description	Required
firstName	String	First name of the individual	Yes
lastName	String	Last name of the individual	Yes
dateOfBirth	Date	Date of birth (format: YYYY-MM-DD)	Yes
addressLine1	String	Primary residential address line	Yes
addressLine3	String	City or locality part of the address	Yes
addressLine5	String	Postal code	Yes
emailAddress	String	Email address of the individual	Yes
consent	Boolean	Consent from the individual for verification	Yes

Parameter	Type	Description
verificationResult	Object	Container for detailed results of the verification.
firstName	Boolean	Result of the first name verification.
lastName	Boolean	Result of the last name verification.
dateOfBirth	Boolean	Result of the date of birth verification.
address	Boolean	Result of the address verification.
addressScore	Float	Numerical score (0-1) representing the address match quality.
verificationStatus	String	Overall status of the verification ("Verified" or "Not Verified").
reason	String	Explanation of the verification results.

Field	Type	Description
name	string	Text displayed on the screen explaining error type.
reason	string	Reason for the error.
status	number	HTTP status code.
message	string	Error message indicating an upstream error.
type	string	Error type.
statusCode	number	Status code representing the error scenario.

Did this page help you?

US Contact Enrichment

Global KYC