Business Partners

Lookup Business Partners

Lookup a business partner in all available data sources.

SecurityapiKey

Request

Request Body schema: application/json

city	string
country	string
houseNo	string
identifierType	string
identifierValue	string
limitResults	integer [ 0 .. 1000 ]
matchingThreshold	number <double> [ 0 .. 1 ]
maxCandidates	integer [ 20 .. 100 ] default: 50
name	string
page	integer >= 0 Default: 0
pageSize	integer [ 1 .. 1000 ] default: 10
postCode	string
startAfter	string
street	string

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/restv3/businesspartners/lookup

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartner": {"addresses": [{"country": {"shortName": "PL"
}
}
],
"identifiers": [{"value": "PL9280012700",
"type": {"technicalKey": "EU_VAT_ID_PL"
}
}
]
}
}

Response samples

application/json

{"pageSize": 0,
"totals": 0,
"page": 0,
"limitResults": 0,
"startAfter": "string",
"nextStartAfter": "string",
"businessPartnerCandidates": [{"cdqId": "string",
"dataSource": "string",
"matchingScore": 0,
"matchingClassification": "string",
"name": "string",
"legalForm": "string",
"status": "string",
"identifiers": [{"identifierType": "string",
"identifierValue": "string"
}
],
"addresses": [{"country": "string",
"countryName": "string",
"region": "string",
"regionName": "string",
"city": "string",
"postCode": "string",
"street": "string",
"houseNo": "string",
"building": "string",
"floor": "string",
"room": "string",
"latitude": 0,
"longitude": 0
}
]
}
]
}