API Restful - Description - B2B - Lookup - GET

Support DQE
Support DQE
  • Updated

CompanyName or CompanyNumber Only

Get Lookupcname request :
https://{SERVER_ADDRESS}/{VERSION}/lookupcname/?CompanyName={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FITLER}

Simply replace the items in braces with your information :

ParameterValue of the parameterValue descriptionMandatory/Optional
Server address{SERVER_ADDRESS}Address of the DQE server that will process the dataMandatory
Version{VERSION}

Version of the API

Example : v1

Mandatory
Licence{LICENCE_CODE}Number assigned to you as your license codeMandatory

CompanyName 

or

CompanyNumber

{INPUT}User inputMandatory
Country{COUNTRY_CODE}ISO country code (3 letters)Mandatory
Filter{FILTER}

Choose the value that you want, if several values, separete them by a comma (,)

- 1 - OPENED DIFFUSIBLE
- 2 - CLOSED DIFFUSIBLE
- 3 - CLOSED OLD (+3 years) DIFFUSIBLE
- 4 - NON-DIFFUSIBLE

Example : Filter=1,2

Optional

Default Value : 1

 

Company Name and Postal Code

Get Checkcname request :
https://{SERVER_ADDRESS}/{VERSION}/checkanme/?CompanyName={INPUT}&Country={COUNTRY_CODE}&PostalCode={POSTALCODE}&Licence={LICENCE_CODE}&Filter={FITLER}

Simply replace the items in braces with your information :

ParameterValue of the parameterValue descriptionMandatory/Optional
Server address{SERVER_ADDRESS}Address of the DQE server that will process the dataMandatory
Version{VERSION}

Version of the API

Example : v1

Mandatory
Licence{LICENCE_CODE}Number assigned to you as your license codeMandatory
CompanyName{INPUT}User inputMandatory
PostalCode{POSTALCODE}Postal codeMandatory
Country{COUNTRY_CODE}ISO country code (3 letters)Mandatory
Filter{FILTER}

Choose the value that you want, if several values, separete them by a comma (,)

- 1 - OPENED DIFFUSIBLE
- 2 - CLOSED DIFFUSIBLE
- 3 - CLOSED OLD (+3 years) DIFFUSIBLE
- 4 - NON-DIFFUSIBLE

Example : Filter=1,2

Optional

Default Value : 1

 

Postal Address only

Get Lookupcadr request :
https://{SERVER_ADDRESS}/{VERSION}/checkname/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Filter={FITLER}

Simply replace the items in braces with your information :

ParameterValue of the parameterValue descriptionMandatory/Optional
Server address{SERVER_ADDRESS}Address of the DQE server that will process the dataMandatory
Version{VERSION}

Version of the API

Example : v1

Mandatory
Licence{LICENCE_CODE}Number assigned to you as your license codeMandatory
Address{ADDRESS}User inputMandatory
PostalCode{POSTALCODE}Postal codeMandatory
City{CITY}CityMandatory
Country{COUNTRY_CODE}ISO country code (3 letters)Mandatory
Filter{FILTER}

Choose the value that you want, if several values, separete them by a comma (,)

- 1 - OPENED DIFFUSIBLE
- 2 - CLOSED DIFFUSIBLE
- 3 - CLOSED OLD (+3 years) DIFFUSIBLE
- 4 - NON-DIFFUSIBLE

Example : Filter=1,2

Optional

Default Value : 1

Related to

Was this article helpful?

0 out of 0 found this helpful