Dictionaries
Many fields are integers (or a small set of strings). Send the number,
not the label. These values are the public contract; they are not
documented as HTTP enums everywhere in the spec.
Title
| Value | Label |
|---|
| 1 | Mr |
| 2 | Mrs |
| 3 | Miss |
| 4 | Ms |
| 5 | Dr |
| 10 | Other — also send State (the title text) |
| 11 | Mx |
Report type
| Value | Label | Notes |
|---|
| 1 | Elite | |
| 3 | Interim | Returned by list-reports; not sent on create |
| 5 | Essential | |
| 6 | Upgraded to Elite | Not allowed on create |
| 7 | Summary | Returned by list-reports |
| 8 | Essential+ | |
| 9 | Essential++ | |
Marital status
| Value | Label |
|---|
| 1 | Married |
| 2 | Civil partnership |
| 3 | Co-habiting |
| 4 | Widow(er) |
| 5 | Separated |
| 6 | Divorced |
| 7 | Single |
Living status
On each AddressHistory item.
| Value | Label |
|---|
| 1 | Owner |
| 2 | Tenant |
| 3 | Living with family |
| 4 | Living with friends |
| 5 | Temporary accommodation |
| 6 | Other |
| 7 | Student accommodation |
Rent and management
| Field | Value | Label |
|---|
RentalFrequency | 1 | Monthly |
RentalFrequency | 2 | Weekly |
HowWillTheProperyBeManaged | 0 | Not applicable |
| 1 | Let only |
| 2 | Property Protect |
| 3 | Managed |
| 4 | Property Passport |
| 5 | Rent collect |
TenancyType is a string, defaulted from address and start
date if omitted:
ASSURED_SHORTHOLD_TENANCY,
ASSURED_PERIODIC_TENANCY,
COMMON_LAW_TENANCY,
STANDARD_OCCUPATION_CONTRACT,
PRIVATE_RESIDENTIAL_TENANCY,
PRIVATE_TENANCY,
COMPANY_LET,
LICENCE_TO_OCCUPY.
If ReferenceRequired is false, send
NoReferencingServiceType: 0 new tenancy, 1 renewal.
Notification events
Codes for POST /Notifications. See
Notifications. Agent webhook topics
are strings, not these integers — see Webhooks.
| Value | Label |
|---|
| 5 | Form submitted |
| 11 | Reference processed |
| 12 | Interim report done |
| 13 | Final report done |
Consent / evidence delivery
SignedConsent.DeliveryMethod and income DeliveryMethod.
| Value | Label |
|---|
| 0 | Unknown |
| 1 | Upload |
| 2 | Email |
| 3 | Fax |
| 4 | Post |
| 10 | Online |
| 11 | Verbal |
| 12 | Verbal inbound |
| 13 | Verbal outbound |
| 14 | Continue to chase |
Income type
Discriminator on evidence objects. Main-employment values are small
integers; many “additional” types are 1025 and above.
| Value | Label |
|---|
| 0 | None |
| 1 | Temporary / contract work |
| 2 | Part-time employed |
| 3 | Full-time employed |
| 4 | Unemployed |
| 5 | Self-employed |
| 6 | Retired |
| 7 | Student |
| 8 | Homemaker |
| 9 | Private income |
| 10 | Foster carer |
| 1025 | State benefits / Universal Credit |
| 1026 | Local housing allowance / housing benefit |
| 1027 | Pension |
| 1028 | Commission or bonuses |
| 1029 | Additional employment |
| 1030 | Relocation package / housing allowance |
| 1031 | Student |
| 1032 | Employee allowances |
| 1033 | Maintenance / CSA |
| 1034 | Dividend payments |
| 1035 | Self-employed |
| 1036 | Foster carer |
| 1037 | Private income |
| 1038 | Savings |
| 1039 | Income from property sale |
| 1040 | Partner’s income |
| 1041 | Tax vouchers |
| 1048577 | Landlord |
| 1048578 | Proof of ownership |
EvidenceType: 1 main income, 2 additional income, 10 landlord.
Schema per type is in the API reference
(EmployedIncome, SelfEmployedIncome, and so on).
KYC
| Field | Value | Label |
|---|
Branch KnowYourCustomerType | 0 | Standalone |
| 1 | Combined with a reference |
Product Type | 0 | Optional |
| 1 | Mandatory |
| 2 | Mandatory above £8,000 rent |
Identity UserType | 1 | Tenant |
| 2 | Guarantor |
| 3 | Permitted occupier |
| 4 | Landlord |
| 5 | Buyer |
| 6 | Seller |
| 7 | Other |