post https://api.w2globaldata.com/kyc-check
Checks the economic status based off client household information.
Compatible Cases
About the service
Geo-Affordability service checks if the specific person's valid economic status based on their regional location.
Product Code: W2-DATA-GEOAFFORDABILITY-UK-007
Does this service leave a credit search Footprint? No
Response
Example response
"w2DataGeoAffordabilityUK007Result": {
"Postcode":"CF119PS",
"PublicDerogatorySegment":{
"Rag":"G",
"Binary":"O"
},
"LifeStyleSegment":{
"Rag":"R",
"Binary":"R"
},
"VulnerableSegment":{
"Rag":"A",
"Binary":"O"
},
"GeoIndicator":"ORO",
"GeoIndex":"2"
}
Response Breakdown
| Property | Type | Description |
|---|---|---|
| postcode | string | Unique code used for identifying UK addresses. |
| publicDerogatorySegment | array of strings | |
| lifeStyleSegment | array of string | |
| vulnerableSegment | array of string | |
| geoIndicator | string | Geo-Affordability Indicator (3 byte) - Exc ONS. |
| geoIndex | integer | Geo-Affordability Index Exc ONS - Super-Low (3), Low (2), Medium (1), High (0). |
Each of the segments contain:
| Property | Type | Notes |
|---|---|---|
| rag | string | Will always be one of the following: R - Red A - Amber G - Green X - Not Assigned |
| binary | string | Will always be R - Red or O - Other |
Sandbox
| Postcode | Public Derogatory Segment (RAG) | Public Derogatory Segment (Binary) | Lifestyle Segment (RAG) | Lifestyle Segment (Binary) | Vulnerable Segment (RAG) | Vulnerable Segment (Binary) | Geo Indicator | Geo Index |
|---|---|---|---|---|---|---|---|---|
| G837BB | A | O | A | O | A | O | OOO | 0 |
| CO154AE | G | O | A | O | O | O | OOO | 0 |
| S87TA | A | O | R | R | A | O | OOO | 1 |
| TS260RF | R | R | R | R | R | R | RRR | 3 |
| TQ88BD | A | O | R | R | R | R | ORR | 2 |
Docs not making sense? Please contact us so we can fix them: [email protected] :)