POST api/Retailer/CreditCheck

Create a new credit check

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
FinanceDetails	This model should be used to populate all the finance details requested by the system to create a Credit Check.	FinanceDetailsModel	None.
CustomerDetails		CustomerInfoModel	None.
EmploymentDetails		EmploymentInfoModel	None.
BankDetails		BankDetailsModel	None.
SuppressCustomerEmails		boolean	None.
IpAddress		string	None.
Source		string	None.
MarketingPreferences		MarketingPreferencesModel	None.
AcceptAllTermsAndConditions		boolean	None.
CustomerRedirectURL		string	None.
ReturnDocumentsForSign	This model should be used to specify whether you want the documents or just the signing link or neither.	ReturnDocumentsEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "FinanceDetails": {
    "RateCardProductId": "9935c9a3-013b-4ad8-9b45-1a8578b4bda3",
    "RateCardProductCode": "sample string 1",
    "CommissionConsent": true,
    "DescriptionOfGoods": "sample string 2",
    "RetailersReference": "sample string 3",
    "Price": 1.0,
    "Deposit": 1.0
  },
  "CustomerDetails": {
    "MiddleName": "sample string 1",
    "MaidenName": "sample string 2",
    "BlackBoxString": "sample string 3",
    "TitleId": "dfe8dadc-a9e9-4e96-b8c4-bc47f274f76f",
    "GenderId": "0b6b1741-d441-445a-91d1-88e257cc748f",
    "MaritalStatusId": "a13be603-0ac3-4df8-a45d-923c550ac9ed",
    "ResidentialStatusId": "2aabb835-0b01-4cd3-b992-169870ef3a78",
    "NumberOfDependants": 1,
    "Vulnerability": true,
    "CurrentAddress": {
      "YearsAtAddressId": "b101d031-b1e5-4951-a79a-53ac0587bb52",
      "PostCode": "sample string 1",
      "City": "sample string 2",
      "Flat": "sample string 3",
      "HouseNumber": "sample string 4",
      "HouseName": "sample string 5",
      "Street": "sample string 6"
    },
    "PreviousAddress1": {
      "YearsAtAddressId": "b101d031-b1e5-4951-a79a-53ac0587bb52",
      "PostCode": "sample string 1",
      "City": "sample string 2",
      "Flat": "sample string 3",
      "HouseNumber": "sample string 4",
      "HouseName": "sample string 5",
      "Street": "sample string 6"
    },
    "PreviousAddress2": {
      "YearsAtAddressId": "b101d031-b1e5-4951-a79a-53ac0587bb52",
      "PostCode": "sample string 1",
      "City": "sample string 2",
      "Flat": "sample string 3",
      "HouseNumber": "sample string 4",
      "HouseName": "sample string 5",
      "Street": "sample string 6"
    },
    "GoodsDeliveryAddress": {
      "YearsAtAddressId": "b101d031-b1e5-4951-a79a-53ac0587bb52",
      "PostCode": "sample string 1",
      "City": "sample string 2",
      "Flat": "sample string 3",
      "HouseNumber": "sample string 4",
      "HouseName": "sample string 5",
      "Street": "sample string 6"
    },
    "CustomerEmail": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "Telephone": "sample string 8",
    "MobileNumber": "sample string 9",
    "DateOfBirth": "2025-09-16T10:26:46.7838402+01:00",
    "MonthlyRentAmount": 1.0,
    "GoodsDeliveryAddressIsTheSameAsCurrentAddress": true
  },
  "EmploymentDetails": {
    "EmploymentStatusId": "f549153f-2975-4414-aff2-f5bd321d9cdb",
    "YearsSelfEmployedId": "8d27c392-5f33-49f0-b4ba-ca32a3902d16",
    "YearsWithEmployerId": "92f6dcbe-2ddf-4064-a097-3c45d55dd6d7",
    "SourceOfIncomeId": "54c5c97e-46aa-459c-a33c-dacdde12e540",
    "TypeOfBusiness": "sample string 1",
    "BusinessName": "sample string 2",
    "MainOccupation": "sample string 3",
    "EmployerName": "sample string 4",
    "GrossAnnualIncome": 1.0,
    "HouseholdAnnualIncome": 1
  },
  "BankDetails": {
    "BankAccountNumber": "sample string 1",
    "BankSortCode": "sample string 2"
  },
  "SuppressCustomerEmails": true,
  "IpAddress": "sample string 2",
  "Source": "sample string 3",
  "MarketingPreferences": {
    "ReceiveInformationViaPost": true,
    "ReceiveInformationViaEmail": true,
    "ReceiveInformationViaSMS": true,
    "ReceiveInformationViaPhone": true,
    "AgreePersonalDetailsToBeDisclosed": true
  },
  "AcceptAllTermsAndConditions": true,
  "CustomerRedirectURL": "sample string 4",
  "ReturnDocumentsForSign": 1
}

text/html

Sample:

{"FinanceDetails":{"RateCardProductId":"9935c9a3-013b-4ad8-9b45-1a8578b4bda3","RateCardProductCode":"sample string 1","CommissionConsent":true,"DescriptionOfGoods":"sample string 2","RetailersReference":"sample string 3","Price":1.0,"Deposit":1.0},"CustomerDetails":{"MiddleName":"sample string 1","MaidenName":"sample string 2","BlackBoxString":"sample string 3","TitleId":"dfe8dadc-a9e9-4e96-b8c4-bc47f274f76f","GenderId":"0b6b1741-d441-445a-91d1-88e257cc748f","MaritalStatusId":"a13be603-0ac3-4df8-a45d-923c550ac9ed","ResidentialStatusId":"2aabb835-0b01-4cd3-b992-169870ef3a78","NumberOfDependants":1,"Vulnerability":true,"CurrentAddress":{"YearsAtAddressId":"b101d031-b1e5-4951-a79a-53ac0587bb52","PostCode":"sample string 1","City":"sample string 2","Flat":"sample string 3","HouseNumber":"sample string 4","HouseName":"sample string 5","Street":"sample string 6"},"PreviousAddress1":{"YearsAtAddressId":"b101d031-b1e5-4951-a79a-53ac0587bb52","PostCode":"sample string 1","City":"sample string 2","Flat":"sample string 3","HouseNumber":"sample string 4","HouseName":"sample string 5","Street":"sample string 6"},"PreviousAddress2":{"YearsAtAddressId":"b101d031-b1e5-4951-a79a-53ac0587bb52","PostCode":"sample string 1","City":"sample string 2","Flat":"sample string 3","HouseNumber":"sample string 4","HouseName":"sample string 5","Street":"sample string 6"},"GoodsDeliveryAddress":{"YearsAtAddressId":"b101d031-b1e5-4951-a79a-53ac0587bb52","PostCode":"sample string 1","City":"sample string 2","Flat":"sample string 3","HouseNumber":"sample string 4","HouseName":"sample string 5","Street":"sample string 6"},"CustomerEmail":"sample string 5","FirstName":"sample string 6","LastName":"sample string 7","Telephone":"sample string 8","MobileNumber":"sample string 9","DateOfBirth":"2025-09-16T10:26:46.7838402+01:00","MonthlyRentAmount":1.0,"GoodsDeliveryAddressIsTheSameAsCurrentAddress":true},"EmploymentDetails":{"EmploymentStatusId":"f549153f-2975-4414-aff2-f5bd321d9cdb","YearsSelfEmployedId":"8d27c392-5f33-49f0-b4ba-ca32a3902d16","YearsWithEmployerId":"92f6dcbe-2ddf-4064-a097-3c45d55dd6d7","SourceOfIncomeId":"54c5c97e-46aa-459c-a33c-dacdde12e540","TypeOfBusiness":"sample string 1","BusinessName":"sample string 2","MainOccupation":"sample string 3","EmployerName":"sample string 4","GrossAnnualIncome":1.0,"HouseholdAnnualIncome":1},"BankDetails":{"BankAccountNumber":"sample string 1","BankSortCode":"sample string 2"},"SuppressCustomerEmails":true,"IpAddress":"sample string 2","Source":"sample string 3","MarketingPreferences":{"ReceiveInformationViaPost":true,"ReceiveInformationViaEmail":true,"ReceiveInformationViaSMS":true,"ReceiveInformationViaPhone":true,"AgreePersonalDetailsToBeDisclosed":true},"AcceptAllTermsAndConditions":true,"CustomerRedirectURL":"sample string 4","ReturnDocumentsForSign":1}

application/xml, text/xml

Sample:

<CreditCheckRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIRequests.CreditCheckRequestModels">
  <AcceptAllTermsAndConditions xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">true</AcceptAllTermsAndConditions>
  <CustomerRedirectURL xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">sample string 4</CustomerRedirectURL>
  <MarketingPreferences xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
    <AgreePersonalDetailsToBeDisclosed>true</AgreePersonalDetailsToBeDisclosed>
    <ReceiveInformationViaEmail>true</ReceiveInformationViaEmail>
    <ReceiveInformationViaPhone>true</ReceiveInformationViaPhone>
    <ReceiveInformationViaPost>true</ReceiveInformationViaPost>
    <ReceiveInformationViaSMS>true</ReceiveInformationViaSMS>
  </MarketingPreferences>
  <ReturnDocumentsForSign xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">NoDocuments</ReturnDocumentsForSign>
  <BankDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
    <d2p1:BankAccountNumber>sample string 1</d2p1:BankAccountNumber>
    <d2p1:BankSortCode>sample string 2</d2p1:BankSortCode>
  </BankDetails>
  <CustomerDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
    <d2p1:CustomerEmail>sample string 5</d2p1:CustomerEmail>
    <d2p1:DateOfBirth>2025-09-16T10:26:46.7838402+01:00</d2p1:DateOfBirth>
    <d2p1:FirstName>sample string 6</d2p1:FirstName>
    <d2p1:GoodsDeliveryAddressIsTheSameAsCurrentAddress>true</d2p1:GoodsDeliveryAddressIsTheSameAsCurrentAddress>
    <d2p1:LastName>sample string 7</d2p1:LastName>
    <d2p1:MobileNumber>sample string 9</d2p1:MobileNumber>
    <d2p1:MonthlyRentAmount>1</d2p1:MonthlyRentAmount>
    <d2p1:Telephone>sample string 8</d2p1:Telephone>
    <d2p1:BlackBoxString>sample string 3</d2p1:BlackBoxString>
    <d2p1:CurrentAddress>
      <d2p1:City>sample string 2</d2p1:City>
      <d2p1:Flat>sample string 3</d2p1:Flat>
      <d2p1:HouseName>sample string 5</d2p1:HouseName>
      <d2p1:HouseNumber>sample string 4</d2p1:HouseNumber>
      <d2p1:PostCode>sample string 1</d2p1:PostCode>
      <d2p1:Street>sample string 6</d2p1:Street>
      <d2p1:YearsAtAddressId>b101d031-b1e5-4951-a79a-53ac0587bb52</d2p1:YearsAtAddressId>
    </d2p1:CurrentAddress>
    <d2p1:GenderId>0b6b1741-d441-445a-91d1-88e257cc748f</d2p1:GenderId>
    <d2p1:GoodsDeliveryAddress>
      <d2p1:City>sample string 2</d2p1:City>
      <d2p1:Flat>sample string 3</d2p1:Flat>
      <d2p1:HouseName>sample string 5</d2p1:HouseName>
      <d2p1:HouseNumber>sample string 4</d2p1:HouseNumber>
      <d2p1:PostCode>sample string 1</d2p1:PostCode>
      <d2p1:Street>sample string 6</d2p1:Street>
      <d2p1:YearsAtAddressId>b101d031-b1e5-4951-a79a-53ac0587bb52</d2p1:YearsAtAddressId>
    </d2p1:GoodsDeliveryAddress>
    <d2p1:MaidenName>sample string 2</d2p1:MaidenName>
    <d2p1:MaritalStatusId>a13be603-0ac3-4df8-a45d-923c550ac9ed</d2p1:MaritalStatusId>
    <d2p1:MiddleName>sample string 1</d2p1:MiddleName>
    <d2p1:NumberOfDependants>1</d2p1:NumberOfDependants>
    <d2p1:PreviousAddress1>
      <d2p1:City>sample string 2</d2p1:City>
      <d2p1:Flat>sample string 3</d2p1:Flat>
      <d2p1:HouseName>sample string 5</d2p1:HouseName>
      <d2p1:HouseNumber>sample string 4</d2p1:HouseNumber>
      <d2p1:PostCode>sample string 1</d2p1:PostCode>
      <d2p1:Street>sample string 6</d2p1:Street>
      <d2p1:YearsAtAddressId>b101d031-b1e5-4951-a79a-53ac0587bb52</d2p1:YearsAtAddressId>
    </d2p1:PreviousAddress1>
    <d2p1:PreviousAddress2>
      <d2p1:City>sample string 2</d2p1:City>
      <d2p1:Flat>sample string 3</d2p1:Flat>
      <d2p1:HouseName>sample string 5</d2p1:HouseName>
      <d2p1:HouseNumber>sample string 4</d2p1:HouseNumber>
      <d2p1:PostCode>sample string 1</d2p1:PostCode>
      <d2p1:Street>sample string 6</d2p1:Street>
      <d2p1:YearsAtAddressId>b101d031-b1e5-4951-a79a-53ac0587bb52</d2p1:YearsAtAddressId>
    </d2p1:PreviousAddress2>
    <d2p1:ResidentialStatusId>2aabb835-0b01-4cd3-b992-169870ef3a78</d2p1:ResidentialStatusId>
    <d2p1:TitleId>dfe8dadc-a9e9-4e96-b8c4-bc47f274f76f</d2p1:TitleId>
    <d2p1:Vulnerability>true</d2p1:Vulnerability>
  </CustomerDetails>
  <EmploymentDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
    <d2p1:BusinessName>sample string 2</d2p1:BusinessName>
    <d2p1:EmployerName>sample string 4</d2p1:EmployerName>
    <d2p1:GrossAnnualIncome>1</d2p1:GrossAnnualIncome>
    <d2p1:HouseholdAnnualIncome>1</d2p1:HouseholdAnnualIncome>
    <d2p1:MainOccupation>sample string 3</d2p1:MainOccupation>
    <d2p1:TypeOfBusiness>sample string 1</d2p1:TypeOfBusiness>
    <d2p1:EmploymentStatusId>f549153f-2975-4414-aff2-f5bd321d9cdb</d2p1:EmploymentStatusId>
    <d2p1:SourceOfIncomeId>54c5c97e-46aa-459c-a33c-dacdde12e540</d2p1:SourceOfIncomeId>
    <d2p1:YearsSelfEmployedId>8d27c392-5f33-49f0-b4ba-ca32a3902d16</d2p1:YearsSelfEmployedId>
    <d2p1:YearsWithEmployerId>92f6dcbe-2ddf-4064-a097-3c45d55dd6d7</d2p1:YearsWithEmployerId>
  </EmploymentDetails>
  <FinanceDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
    <d2p1:Deposit>1</d2p1:Deposit>
    <d2p1:DescriptionOfGoods>sample string 2</d2p1:DescriptionOfGoods>
    <d2p1:Price>1</d2p1:Price>
    <d2p1:RetailersReference>sample string 3</d2p1:RetailersReference>
    <d2p1:CommissionConsent>true</d2p1:CommissionConsent>
    <d2p1:RateCardProductCode>sample string 1</d2p1:RateCardProductCode>
    <d2p1:RateCardProductId>9935c9a3-013b-4ad8-9b45-1a8578b4bda3</d2p1:RateCardProductId>
  </FinanceDetails>
  <IpAddress>sample string 2</IpAddress>
  <Source>sample string 3</Source>
  <SuppressCustomerEmails>true</SuppressCustomerEmails>
</CreditCheckRequestModel>

Response Information

Resource Description

If the credit check is with status declined there will be no returned documents. Guaranteed Application Results: Each email below leads to different credit check status.For successful testing, the logged retailer user need to have the "TestResultsProduct" in his/her available products.This product must use the "TestResultsCreditPolicty" in order for the API to make decisions based on the different email addresses.The test product can be applied to a retailer by an OCRF user.This product must be chosen when a new credit check is created. For 'accepted' status use ocapital.test1@gmail.com as customer email address. For 'referred' status use ocapital.test2 @gmail.com as customer email address. For 'declined' status use ocapital.test3 @gmail.com as customer email address. Possible error responses: 1. Invalid input fields - {"errors": {"invalidFieldName": ["Error message containing more details about the failure."], "invalidFieldName2": ["Error message containing more details about the failure."]}} 2. Error on validation bank details /Experian/ - {"LoanApplicationId" : "Id", "ErrorMessage" : "Error message from Experian"}

UpdateCustomerBankDetailsResponse

Name	Type	Additional information
LoanApplicationId	globally unique identifier	None.
CreditCheckId	globally unique identifier	None.
Status	string	None.
StatusNumber	integer	None.
Documents	Dictionary of string [key] and string [value]	None.
DocumentsFormat	DocumentFormatEnum	None.
SignDocumentsUrl	string	None.
LoanReferenceNumber	string	None.
CreditCheckStatus	string	None.
CreditCheckStatusNumber	integer	None.
Info	string	None.
UpperAmendValue	decimal number	None.
InitialFinanceOfferDetails	FinanceOfferDetails	None.
NewFinanceOfferDetails	FinanceOfferDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "LoanApplicationId": "b17cd80a-e386-4268-bb9b-22f60708f5ed",
  "CreditCheckId": "3796f3f8-1003-4ca7-9494-c4175c9c13c4",
  "Status": "sample string 2",
  "StatusNumber": 3,
  "Documents": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "DocumentsFormat": 1,
  "SignDocumentsUrl": "sample string 4",
  "LoanReferenceNumber": "sample string 5",
  "CreditCheckStatus": "sample string 6",
  "CreditCheckStatusNumber": 7,
  "Info": "sample string 8",
  "UpperAmendValue": 1.0,
  "InitialFinanceOfferDetails": {
    "FirstPayment": 1.0,
    "MonthlyPayment": 2.0,
    "MonthlyInterestRate": 3.1,
    "APR": 4.1,
    "TotalInterestPayable": 5.0,
    "ProductCode": "sample string 6"
  },
  "NewFinanceOfferDetails": {
    "FirstPayment": 1.0,
    "MonthlyPayment": 2.0,
    "MonthlyInterestRate": 3.1,
    "APR": 4.1,
    "TotalInterestPayable": 5.0,
    "ProductCode": "sample string 6"
  }
}

text/html

Sample:

{"LoanApplicationId":"b17cd80a-e386-4268-bb9b-22f60708f5ed","CreditCheckId":"3796f3f8-1003-4ca7-9494-c4175c9c13c4","Status":"sample string 2","StatusNumber":3,"Documents":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"DocumentsFormat":1,"SignDocumentsUrl":"sample string 4","LoanReferenceNumber":"sample string 5","CreditCheckStatus":"sample string 6","CreditCheckStatusNumber":7,"Info":"sample string 8","UpperAmendValue":1.0,"InitialFinanceOfferDetails":{"FirstPayment":1.0,"MonthlyPayment":2.0,"MonthlyInterestRate":3.1,"APR":4.1,"TotalInterestPayable":5.0,"ProductCode":"sample string 6"},"NewFinanceOfferDetails":{"FirstPayment":1.0,"MonthlyPayment":2.0,"MonthlyInterestRate":3.1,"APR":4.1,"TotalInterestPayable":5.0,"ProductCode":"sample string 6"}}

application/xml, text/xml

Sample:

<UpdateCustomerBankDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.CreditCheckResponses">
  <CreditCheckId>3796f3f8-1003-4ca7-9494-c4175c9c13c4</CreditCheckId>
  <CreditCheckStatus>sample string 6</CreditCheckStatus>
  <CreditCheckStatusNumber>7</CreditCheckStatusNumber>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Documents>
  <DocumentsFormat>PDF</DocumentsFormat>
  <Info>sample string 8</Info>
  <InitialFinanceOfferDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
    <d2p1:APR>4.1</d2p1:APR>
    <d2p1:FirstPayment>1</d2p1:FirstPayment>
    <d2p1:MonthlyInterestRate>3.1</d2p1:MonthlyInterestRate>
    <d2p1:MonthlyPayment>2</d2p1:MonthlyPayment>
    <d2p1:ProductCode>sample string 6</d2p1:ProductCode>
    <d2p1:TotalInterestPayable>5</d2p1:TotalInterestPayable>
  </InitialFinanceOfferDetails>
  <LoanApplicationId>b17cd80a-e386-4268-bb9b-22f60708f5ed</LoanApplicationId>
  <LoanReferenceNumber>sample string 5</LoanReferenceNumber>
  <NewFinanceOfferDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
    <d2p1:APR>4.1</d2p1:APR>
    <d2p1:FirstPayment>1</d2p1:FirstPayment>
    <d2p1:MonthlyInterestRate>3.1</d2p1:MonthlyInterestRate>
    <d2p1:MonthlyPayment>2</d2p1:MonthlyPayment>
    <d2p1:ProductCode>sample string 6</d2p1:ProductCode>
    <d2p1:TotalInterestPayable>5</d2p1:TotalInterestPayable>
  </NewFinanceOfferDetails>
  <SignDocumentsUrl>sample string 4</SignDocumentsUrl>
  <Status>sample string 2</Status>
  <StatusNumber>3</StatusNumber>
  <UpperAmendValue>1</UpperAmendValue>
</UpdateCustomerBankDetailsResponse>