Sign in

v1

latestOpenAPI 3.0.12026-08-063340143.9 KB
ID lookup services

ID lookup service by dataset

A lookup service, largely intended for debug purposes, to enable verification that an external ID for a specific dataset (e.g. WoRMS) has been indexed and to check if the ID has been associated with a taxon in the main index.

get/v2/species/match/id/{datasetId}/{identifier}

Path parameters

datasetIdstring required
identifierstring required

Response

Name usage suggestions found

idstring

The external identifier that may or may not have been associated with the main index

mainIndexIDstring

The main index identifier that the external identifier was matched to

datasetKeystring

The gbif key of the dataset containing the joined external ID

clbDatasetKeystring

The checklistbank dataset key of the joined external ID

datasetTitlestring

The dataset title of the joined external ID

parentIDstring

The parent ID of the external identifier

scientificNamestring

The scientific name associated with the external identifier

acceptedTaxonIDstring

The accepted taxon ID of the external identifier

rankstring

The rank of the external identifier

statusstring

The status of the external identifier

recognisedVariantsstring[]

Recognised variants of this ID