Eligibility Check Request

Api description for Eligibility Check Request.

URL

POST /merchant-api/v2/eligibility-check

HTTP response codes

200 - Successful operation
401 - Unauthorized, maybe the credentials are missing. For more information, see security
403 - Forbidden, the HMAC may be wrong or out of date. For more information, see security

Request

Attribute	Type	Length	Description
`invoiceAddress` required	Address
`applicant` required	Applicant

Response

Attribute	Type	Length	Description
`isCustomerEligibleForInvoice` required	Boolean

Type: Applicant

Attribute	Type	Length	Description
`emailAddress` required	String	320	The email address of the customer. We don`t validate if an email address is valid or not.

Type: Address

Attribute	Type	Length	Description
`countryCode` required	Enum String	10	The country code of the address. For now this should always be `NL`
`houseNumber` required	String	10	The house number of the given address.
`houseNumberAddition`	String	10	The addition to the house number.
`postalCode` required	String	10	The (official) postcode of the address. The postal code requires the format `NNNNAA` or `NNNN AA` for Dutch postal codes. Example: `8011NW`
`street` required	String	50	The name of the street.
`city` required	String	50	The name of the city.

Example

Request

fetch('https://....../merchant-api/v2/eligibility-check', {
  method: 'POST',
  headers: {
    Authorization: 'Basic xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    'X-Authorization': 'hmac example:xxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxx/xxx=:nonce:xxxxxxxxxx',
    'Content-Type': 'application/json'
  },
  body: {
    applicant: {
      emailAddress: '[email protected]',
    }
    invoiceAddress: {
      countryCode: 'NL',
      houseNumber: '81',
      houseNumberAddition: null,
      postalCode: '4006EA'
      street: 'Dodewaardlaan',
      city: 'Tiel',
    },
  }
})

Response

{
  isCustomerEligibleForInvoice: true;
}