Schema
Scalars
Enums
-
Action -
BtlExpenditureType -
BtlIncomeType -
BtlPropertyUsage -
BtlReason -
BtlType -
CaseResultStatus -
CaseStatisticType -
CaseStatus -
ContractType -
ContractorType -
Country -
EmploymentStatus -
ExistingBankProvider -
ExistingMortgageLender -
ExpenditureType -
ExpenseType -
ForeignNationalResidence -
ForeignStatus -
Gender -
IncomeType -
IndividualOrCompany -
LenderNoticeLevel -
LenderType -
LifetimeProduct -
MaritalStatus -
MortgageTerm -
MortgageType -
Nationality -
Ownership -
PropertyMortgageType -
PropertyStyle -
PropertyType -
PropertyUsage -
Reason -
Region -
RemortgageType -
ResidentialStatus -
Role -
SingleOrJoint -
TaxBand -
TimeInEmployment -
UserStatus -
WebhookTopic
Objects
-
AdditionalIncomeCase -
AddressCase -
AdverseCreditCase -
Advisor -
ApplicantCase -
ApplicantShort -
ArrearCase -
BankruptcyCase -
BtlAdditionalIncomeCase -
BtlApplicantCase -
BtlCase -
BtlExpenditureCase -
BtlIncomeCase -
BtlLoanCase -
BtlPersonalDetailsCase -
BtlPropertyCase -
BtlPropertyCostCase -
Case -
CaseResult -
CaseResultIndex -
CaseStatistic -
CaseStatistics -
CcjCase -
CisContractorCase -
Company -
CompanyDirectorIncomeCase -
ContractorIncomeCase -
CreateCompanyResult -
CreditArrearCase -
CreditCase -
CreditCheckCase -
CreditDefaultCase -
DebtManagementPlanCase -
ExpenditureCase -
FuturePensionIncomeCase -
IncomeCase -
IvaCase -
Lender -
LenderNotice -
LivingExpensesCase -
LoanCase -
MagicLink -
MortgageCase -
OnsOccupation -
OnsOccupationCase -
PaginatedCases -
PayDayLoanCase -
PersonalDetailsCase -
PreferenceCase -
PropertyCase -
RepossessionCase -
ResidenceHistoryCase -
ResidentialCase -
RootMutationType -
RootQueryType -
RootSubscriptionType -
SelfEmployedIncomeCase -
Site -
TermCase -
UmbrellaContractorCase -
User -
WebhookSubscription
Input Objects
-
AdditionalIncome -
Address -
AdminUserInput -
AdverseCredit -
Applicant -
ApplicantDraft -
Arrear -
Bankruptcy -
BtlAdditionalIncome -
BtlApplicant -
BtlApplicantDraft -
BtlExpenditure -
BtlIncome -
BtlLoan -
BtlLoanDraft -
BtlPersonalDetails -
BtlPersonalDetailsDraft -
BtlProperty -
BtlPropertyCost -
BtlPropertyCostDraft -
Ccj -
CisContractor -
CompanyAddress -
CompanyDirectorIncome -
CompanyDirectorIncomeDraft -
CompanyInput -
ContractorIncome -
ContractorIncomeDraft -
Credit -
CreditArrear -
CreditCheck -
CreditDefault -
DebtManagementPlan -
Expenditure -
FuturePensionIncome -
Income -
IncomeDraft -
Iva -
LivingExpenses -
Loan -
LoanDraft -
Mortgage -
OnsOccupationReference -
PayDayLoan -
PersonalDetails -
PersonalDetailsDraft -
Preference -
Property -
Repossession -
ResidenceHistory -
SelfEmployedIncome -
SiteInput -
Term -
UmbrellaContractor -
UserInput
RootMutationType (OBJECT)
Schema Definition
type RootMutationType {
# Clones the given case. Accepts both residential and buy to let cases.
cloneCase: Case!
# Completes the given case.
completeCase: Case!
# Creates a buy-to-let, BTL, case to run the affordability results for.
createBtlCase: Case!
# Creates a draft buy-to-let, BTL, case to run the affordability results lazily.
createBtlCaseDraft: Case!
# Creates a residential case to run the affordability results for.
createCase: Case!
# Creates a draft residential case to run the affordability results
lazily.
createCaseDraft: Case!
# Creates a company with the given details for third-party API integration.
Requires an integration token.
createCompany: CreateCompanyResult!
# Creates a new or updates an existing webhook subscription.
createOrUpdateWebhookSubscription: WebhookSubscription!
# Creates broker tokens with the given email address for third-party API integration.
Requires a company token.
createTokenByEmail: String!
# Creates broker tokens with the given unique identifier for third-party API integration.
Requires a company token.
createTokenByUuid: String!
# Creates broker tokens with the given email or uuid for third-party API integration.
Requires a company token.
createTokenForBroker: String!
# Creates company tokens with the given fca number, company number or domain for third-party API integration.
Requires an integration token.
createTokenForCompany: String!
# Creates a user with the given details for the current company.
createUser: User!
# Evaluates the results of the case. Accepts both residential and buy to let cases.
Check `case_results` subscription for listening to the results as they arrive.
invokeCaseResults: Case!
# Creates a magic link for the specified action
magicLink: MagicLink!
# Updates details of a buy-to-let, or BTL, draft case.
updateBtlCaseDraft: Case!
# Updates details of a residential draft case.
updateCaseDraft: Case!
}