POST api/Delegation/Omni

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
application_amendment		string	None.
application_ref		string	None.
retailer_name		string	None.
retailer_id		string	None.
ipAddress		string	None.
source		string	None.
check_type		CheckTypeEnum	None.
loan_value		decimal number	None.
deposit		decimal number	None.
term		integer	None.
item_name		string	None.
item_price		decimal number	None.
apr		decimal number	None.
subsequent_payments		decimal number	None.
minimum_advance		decimal number	None.
maximum_advance		decimal number	None.
deferred_period		integer	None.
countOfRejectedLoansInLast30Days		integer	None.
countOfCreatedLoansInLast30Days		integer	None.
countOfRelatedLoansInLast30Days		integer	None.
countOfRelatedLoansInLast60Days		integer	None.
totalLoanAmountOfExistingNotFullyPaidLoans		decimal number	None.
customerDetails		CustomerRequestModel	None.
blackboxstring	This is a field that contains information about device from which the loan application is created. For more information contact support team.	string	None.
previous_documents_signed		string	None.

Request Formats

application/json, text/json

Sample:

{
  "application_amendment": "sample string 1",
  "application_ref": "sample string 2",
  "retailer_name": "sample string 3",
  "retailer_id": "sample string 4",
  "ipAddress": "sample string 5",
  "source": "sample string 6",
  "check_type": 0,
  "loan_value": 1.0,
  "deposit": 1.0,
  "term": 1,
  "item_name": "sample string 7",
  "item_price": 1.0,
  "apr": 1.0,
  "subsequent_payments": 1.0,
  "minimum_advance": 1.0,
  "maximum_advance": 1.0,
  "deferred_period": 1,
  "countOfRejectedLoansInLast30Days": 1,
  "countOfCreatedLoansInLast30Days": 1,
  "countOfRelatedLoansInLast30Days": 1,
  "countOfRelatedLoansInLast60Days": 1,
  "totalLoanAmountOfExistingNotFullyPaidLoans": 1.0,
  "customerDetails": {
    "customer_email": "sample string 1",
    "first_name": "sample string 2",
    "last_name": "sample string 3",
    "telephone": "sample string 4",
    "date_of_birth": "2025-05-12T19:58:53.9939487+01:00",
    "title": "sample string 6",
    "middle_name": "sample string 7",
    "maiden_name": "sample string 8",
    "marital_status": "sample string 9",
    "gender": "sample string 10",
    "residential_status": "sample string 11",
    "monthly_rent_amount": 1.0,
    "number_of_dependants": 1,
    "contact_number": "sample string 12",
    "current_address": {
      "years_at_address": 1,
      "post_code": "sample string 2",
      "city": "sample string 3",
      "flat": "sample string 4",
      "house_number": "sample string 5",
      "house_name": "sample string 6",
      "street": "sample string 7"
    },
    "previous_addresses": [
      {
        "order": 1,
        "years_at_address": 1,
        "post_code": "sample string 2",
        "city": "sample string 3",
        "flat": "sample string 4",
        "house_number": "sample string 5",
        "house_name": "sample string 6",
        "street": "sample string 7"
      },
      {
        "order": 1,
        "years_at_address": 1,
        "post_code": "sample string 2",
        "city": "sample string 3",
        "flat": "sample string 4",
        "house_number": "sample string 5",
        "house_name": "sample string 6",
        "street": "sample string 7"
      }
    ],
    "delivery_address": {
      "years_at_address": 1,
      "post_code": "sample string 2",
      "city": "sample string 3",
      "flat": "sample string 4",
      "house_number": "sample string 5",
      "house_name": "sample string 6",
      "street": "sample string 7"
    },
    "employment_details": {
      "employment_status": "sample string 1",
      "main_occupation": "sample string 2",
      "employer_name": "sample string 3",
      "years_with_employer": 1,
      "gross_annual_income": 1.0,
      "household_annual_income": 1
    },
    "bank_details": {
      "bank_account_number": "sample string 1",
      "bank_sort_code": "sample string 2"
    }
  },
  "blackboxstring": "sample string 8",
  "previous_documents_signed": "sample string 9"
}

text/html

Sample:

{"application_amendment":"sample string 1","application_ref":"sample string 2","retailer_name":"sample string 3","retailer_id":"sample string 4","ipAddress":"sample string 5","source":"sample string 6","check_type":0,"loan_value":1.0,"deposit":1.0,"term":1,"item_name":"sample string 7","item_price":1.0,"apr":1.0,"subsequent_payments":1.0,"minimum_advance":1.0,"maximum_advance":1.0,"deferred_period":1,"countOfRejectedLoansInLast30Days":1,"countOfCreatedLoansInLast30Days":1,"countOfRelatedLoansInLast30Days":1,"countOfRelatedLoansInLast60Days":1,"totalLoanAmountOfExistingNotFullyPaidLoans":1.0,"customerDetails":{"customer_email":"sample string 1","first_name":"sample string 2","last_name":"sample string 3","telephone":"sample string 4","date_of_birth":"2025-05-12T19:58:53.9939487+01:00","title":"sample string 6","middle_name":"sample string 7","maiden_name":"sample string 8","marital_status":"sample string 9","gender":"sample string 10","residential_status":"sample string 11","monthly_rent_amount":1.0,"number_of_dependants":1,"contact_number":"sample string 12","current_address":{"years_at_address":1,"post_code":"sample string 2","city":"sample string 3","flat":"sample string 4","house_number":"sample string 5","house_name":"sample string 6","street":"sample string 7"},"previous_addresses":[{"order":1,"years_at_address":1,"post_code":"sample string 2","city":"sample string 3","flat":"sample string 4","house_number":"sample string 5","house_name":"sample string 6","street":"sample string 7"},{"order":1,"years_at_address":1,"post_code":"sample string 2","city":"sample string 3","flat":"sample string 4","house_number":"sample string 5","house_name":"sample string 6","street":"sample string 7"}],"delivery_address":{"years_at_address":1,"post_code":"sample string 2","city":"sample string 3","flat":"sample string 4","house_number":"sample string 5","house_name":"sample string 6","street":"sample string 7"},"employment_details":{"employment_status":"sample string 1","main_occupation":"sample string 2","employer_name":"sample string 3","years_with_employer":1,"gross_annual_income":1.0,"household_annual_income":1},"bank_details":{"bank_account_number":"sample string 1","bank_sort_code":"sample string 2"}},"blackboxstring":"sample string 8","previous_documents_signed":"sample string 9"}

application/xml, text/xml

Sample:

<DelegationRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIRequests.DelegationRequestModels">
  <APR>1</APR>
  <ApplicationAmendment>sample string 1</ApplicationAmendment>
  <ApplicationReference>sample string 2</ApplicationReference>
  <BlackBoxString>sample string 8</BlackBoxString>
  <CheckType>Undefined</CheckType>
  <CountOfCreatedLoansInLast30Days>1</CountOfCreatedLoansInLast30Days>
  <CountOfRejectedLoansInLast30Days>1</CountOfRejectedLoansInLast30Days>
  <CountOfRelatedLoansInLast30Days>1</CountOfRelatedLoansInLast30Days>
  <CountOfRelatedLoansInLast60Days>1</CountOfRelatedLoansInLast60Days>
  <CustomerDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIRequests.DelegationRequestModels.DelegationRequestModels">
    <d2p1:BankDetails>
      <d2p1:BankAccountNumber>sample string 1</d2p1:BankAccountNumber>
      <d2p1:BankSortCode>sample string 2</d2p1:BankSortCode>
    </d2p1:BankDetails>
    <d2p1:CurrentAddress>
      <City>sample string 3</City>
      <Flat>sample string 4</Flat>
      <HouseName>sample string 6</HouseName>
      <HouseNumber>sample string 5</HouseNumber>
      <PostCode>sample string 2</PostCode>
      <Street>sample string 7</Street>
      <d2p1:YearsAtAddress>1</d2p1:YearsAtAddress>
    </d2p1:CurrentAddress>
    <d2p1:CustomerEmail>sample string 1</d2p1:CustomerEmail>
    <d2p1:DateOfBirth>2025-05-12T19:58:53.9939487+01:00</d2p1:DateOfBirth>
    <d2p1:DeliveryAddress>
      <City>sample string 3</City>
      <Flat>sample string 4</Flat>
      <HouseName>sample string 6</HouseName>
      <HouseNumber>sample string 5</HouseNumber>
      <PostCode>sample string 2</PostCode>
      <Street>sample string 7</Street>
      <d2p1:YearsAtAddress>1</d2p1:YearsAtAddress>
    </d2p1:DeliveryAddress>
    <d2p1:EmploymentDetails>
      <d2p1:EmployerName>sample string 3</d2p1:EmployerName>
      <d2p1:EmploymentStatus>sample string 1</d2p1:EmploymentStatus>
      <d2p1:GrossAnnualIncome>1</d2p1:GrossAnnualIncome>
      <d2p1:HouseholdAnnualIncome>1</d2p1:HouseholdAnnualIncome>
      <d2p1:MainOccupation>sample string 2</d2p1:MainOccupation>
      <d2p1:YearsWithEmployer>1</d2p1:YearsWithEmployer>
    </d2p1:EmploymentDetails>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:Gender>sample string 10</d2p1:Gender>
    <d2p1:LastName>sample string 3</d2p1:LastName>
    <d2p1:MaidenName>sample string 8</d2p1:MaidenName>
    <d2p1:MaritalStatus>sample string 9</d2p1:MaritalStatus>
    <d2p1:MiddleName>sample string 7</d2p1:MiddleName>
    <d2p1:MobileNumber>sample string 12</d2p1:MobileNumber>
    <d2p1:MonthlyRentAmount>1</d2p1:MonthlyRentAmount>
    <d2p1:NumberOfDependants>1</d2p1:NumberOfDependants>
    <d2p1:PreviousAddresses>
      <d2p1:PreviousAddressRequestModel>
        <City>sample string 3</City>
        <Flat>sample string 4</Flat>
        <HouseName>sample string 6</HouseName>
        <HouseNumber>sample string 5</HouseNumber>
        <PostCode>sample string 2</PostCode>
        <Street>sample string 7</Street>
        <d2p1:YearsAtAddress>1</d2p1:YearsAtAddress>
        <d2p1:Order>1</d2p1:Order>
      </d2p1:PreviousAddressRequestModel>
      <d2p1:PreviousAddressRequestModel>
        <City>sample string 3</City>
        <Flat>sample string 4</Flat>
        <HouseName>sample string 6</HouseName>
        <HouseNumber>sample string 5</HouseNumber>
        <PostCode>sample string 2</PostCode>
        <Street>sample string 7</Street>
        <d2p1:YearsAtAddress>1</d2p1:YearsAtAddress>
        <d2p1:Order>1</d2p1:Order>
      </d2p1:PreviousAddressRequestModel>
    </d2p1:PreviousAddresses>
    <d2p1:ResidentialStatus>sample string 11</d2p1:ResidentialStatus>
    <d2p1:Telephone>sample string 4</d2p1:Telephone>
    <d2p1:Title>sample string 6</d2p1:Title>
  </CustomerDetails>
  <DeferredPeriod>1</DeferredPeriod>
  <Deposit>1</Deposit>
  <IPAddress>sample string 5</IPAddress>
  <ItemName>sample string 7</ItemName>
  <ItemPrice>1</ItemPrice>
  <LoanValue>1</LoanValue>
  <MaximumAdvance>1</MaximumAdvance>
  <MinimumAdvance>1</MinimumAdvance>
  <PreviousDocumentsSigned>sample string 9</PreviousDocumentsSigned>
  <RetailerId>sample string 4</RetailerId>
  <RetailerName>sample string 3</RetailerName>
  <Source>sample string 6</Source>
  <SubsequentPayments>1</SubsequentPayments>
  <Term>1</Term>
  <TotalLoanAmountOfExistingNotFullyPaidLoans>1</TotalLoanAmountOfExistingNotFullyPaidLoans>
</DelegationRequestModel>

Response Information

Resource Description

DelegationResponseModel

Name	Type	Additional information
Errors	Dictionary of string [key] and string [value]	None.
RulesApplied	Collection of RulesAppliedModel	None.
Decision	string	None.
DecisionId	string	None.
ApplicationReference	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Errors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "RulesApplied": [
    {
      "RuleName": "sample string 1",
      "RuleNumber": "sample string 2",
      "Field": "sample string 3",
      "Value": "sample string 4",
      "IsAuthenticatePlus": true,
      "RuleType": "sample string 6",
      "RuleResult": "sample string 7"
    },
    {
      "RuleName": "sample string 1",
      "RuleNumber": "sample string 2",
      "Field": "sample string 3",
      "Value": "sample string 4",
      "IsAuthenticatePlus": true,
      "RuleType": "sample string 6",
      "RuleResult": "sample string 7"
    }
  ],
  "Decision": "sample string 1",
  "DecisionId": "sample string 2",
  "ApplicationReference": "sample string 3"
}

text/html

Sample:

{"Errors":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"RulesApplied":[{"RuleName":"sample string 1","RuleNumber":"sample string 2","Field":"sample string 3","Value":"sample string 4","IsAuthenticatePlus":true,"RuleType":"sample string 6","RuleResult":"sample string 7"},{"RuleName":"sample string 1","RuleNumber":"sample string 2","Field":"sample string 3","Value":"sample string 4","IsAuthenticatePlus":true,"RuleType":"sample string 6","RuleResult":"sample string 7"}],"Decision":"sample string 1","DecisionId":"sample string 2","ApplicationReference":"sample string 3"}

application/xml, text/xml

Sample:

<DelegationResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.DelegationResponses.DelegationResponseModels">
  <ApplicationReference>sample string 3</ApplicationReference>
  <Decision>sample string 1</Decision>
  <DecisionId>sample string 2</DecisionId>
  <Errors 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>
  </Errors>
  <RulesApplied>
    <RulesAppliedModel>
      <Field>sample string 3</Field>
      <IsAuthenticatePlus>true</IsAuthenticatePlus>
      <RuleName>sample string 1</RuleName>
      <RuleNumber>sample string 2</RuleNumber>
      <RuleResult>sample string 7</RuleResult>
      <RuleType>sample string 6</RuleType>
      <Value>sample string 4</Value>
    </RulesAppliedModel>
    <RulesAppliedModel>
      <Field>sample string 3</Field>
      <IsAuthenticatePlus>true</IsAuthenticatePlus>
      <RuleName>sample string 1</RuleName>
      <RuleNumber>sample string 2</RuleNumber>
      <RuleResult>sample string 7</RuleResult>
      <RuleType>sample string 6</RuleType>
      <Value>sample string 4</Value>
    </RulesAppliedModel>
  </RulesApplied>
</DelegationResponseModel>