Sign in

v1

latestOpenAPI 3.0.12026-08-063340143.9 KB
Searching names

Fuzzy name match service (Version 2)

Fuzzy matches scientific names against the Taxonomy with the optional classification provided. If a classification is provided and strict is not set to true, the default matching will also try to match against these if no direct match is found for the name parameter alone.

Additionally, a lookup may be performed by providing the usageKey which will short-circuit the name-based matching and ONLY use the given key, either finding the concept or returning no match.

get/v2/species/match

Query parameters

usageKeystring

The usage key to look up. When provided, all other fields are ignored.

taxonIDstring

The taxonID to match. Matches to a taxonID will take precedence over scientificName values supplied. A comparison of the matched scientific and taxonID is performed to check for inconsistencies. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:taxonID'>taxonID</a> for more details. <br/>Sources of recognised identifiers include: <ul><li><a href="https://www.gbif.org/dataset/046bbc50-cae2-47ff-aa43-729fbf53f7c5" target="_blank">International Plant Names Index (IPNI)</a> - Example identifiers:<ul><li>urn:lsid:ipni.org:names:2006-1</li><li>ipni:2006-1</li><li>https://www.ipni.org/n/2006-1</li></ul></li><li><a href="https://www.gbif.org/dataset/2d59e5db-57ad-41ff-97d6-11f5fb264527" target="_blank">World Register of Marine Species</a> - Example identifiers:<ul><li>urn:lsid:marinespecies.org:taxname:105838</li><li>AphiaID:105838</li></ul></li><li><a href="https://www.gbif.org/dataset/de8934f4-a136-481c-a87a-b0b202b80a31" target="_blank">Dyntaxa. Svensk taxonomisk databas</a> - Example identifiers:<ul><li>urn:lsid:dyntaxa.se:Taxon:103038</li></ul></li><li><a href="https://www.gbif.org/dataset/9ca92552-f23a-41a8-a140-01abaa31c931" target="_blank">The Integrated Taxonomic Information System</a> - Example identifiers:<ul><li>itis:179628</li><li>tsn:179628</li></ul></li><li><a href="https://www.gbif.org/dataset/dbaa27eb-29e7-4cbb-8eab-3f689cfce116" target="_blank">United Kingdom Species Inventory (UKSI)</a> - Example identifiers:<ul><li>NHMSYS0000530537</li></ul></li></ul>

taxonConceptIDstring

The taxonConceptID to match. Matches to a taxonConceptID will take precedence over scientificName values supplied. A comparison of the matched scientific and taxonConceptID is performed to check for inconsistencies. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:taxonConceptID'>taxonConceptID</a> for more details. <br/>Sources of recognised identifiers include: <ul><li><a href="https://www.gbif.org/dataset/046bbc50-cae2-47ff-aa43-729fbf53f7c5" target="_blank">International Plant Names Index (IPNI)</a> - Example identifiers:<ul><li>urn:lsid:ipni.org:names:2006-1</li><li>ipni:2006-1</li><li>https://www.ipni.org/n/2006-1</li></ul></li><li><a href="https://www.gbif.org/dataset/2d59e5db-57ad-41ff-97d6-11f5fb264527" target="_blank">World Register of Marine Species</a> - Example identifiers:<ul><li>urn:lsid:marinespecies.org:taxname:105838</li><li>AphiaID:105838</li></ul></li><li><a href="https://www.gbif.org/dataset/de8934f4-a136-481c-a87a-b0b202b80a31" target="_blank">Dyntaxa. Svensk taxonomisk databas</a> - Example identifiers:<ul><li>urn:lsid:dyntaxa.se:Taxon:103038</li></ul></li><li><a href="https://www.gbif.org/dataset/9ca92552-f23a-41a8-a140-01abaa31c931" target="_blank">The Integrated Taxonomic Information System</a> - Example identifiers:<ul><li>itis:179628</li><li>tsn:179628</li></ul></li><li><a href="https://www.gbif.org/dataset/dbaa27eb-29e7-4cbb-8eab-3f689cfce116" target="_blank">United Kingdom Species Inventory (UKSI)</a> - Example identifiers:<ul><li>NHMSYS0000530537</li></ul></li></ul>

scientificNameIDstring

The scientificNameID to match. Matches to a scientificNameID will take precedence over scientificName values supplied. A comparison of the matched scientific and scientificNameID is performed to check for inconsistencies. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:scientificNameID'>scientificNameID</a> for more details <br/>Sources of recognised identifiers include: <ul><li><a href="https://www.gbif.org/dataset/046bbc50-cae2-47ff-aa43-729fbf53f7c5" target="_blank">International Plant Names Index (IPNI)</a> - Example identifiers:<ul><li>urn:lsid:ipni.org:names:2006-1</li><li>ipni:2006-1</li><li>https://www.ipni.org/n/2006-1</li></ul></li><li><a href="https://www.gbif.org/dataset/2d59e5db-57ad-41ff-97d6-11f5fb264527" target="_blank">World Register of Marine Species</a> - Example identifiers:<ul><li>urn:lsid:marinespecies.org:taxname:105838</li><li>AphiaID:105838</li></ul></li><li><a href="https://www.gbif.org/dataset/de8934f4-a136-481c-a87a-b0b202b80a31" target="_blank">Dyntaxa. Svensk taxonomisk databas</a> - Example identifiers:<ul><li>urn:lsid:dyntaxa.se:Taxon:103038</li></ul></li><li><a href="https://www.gbif.org/dataset/9ca92552-f23a-41a8-a140-01abaa31c931" target="_blank">The Integrated Taxonomic Information System</a> - Example identifiers:<ul><li>itis:179628</li><li>tsn:179628</li></ul></li><li><a href="https://www.gbif.org/dataset/dbaa27eb-29e7-4cbb-8eab-3f689cfce116" target="_blank">United Kingdom Species Inventory (UKSI)</a> - Example identifiers:<ul><li>NHMSYS0000530537</li></ul></li></ul>

scientificNamestring

The scientific name to fuzzy match against. May include the authorship and year. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:scientificName'>scientificName</a> for more details

scientificNameAuthorshipstring

The scientific name authorship to match against. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:scientificNameAuthorship'>scientificNameAuthorship</a> for more details

taxonRank'SUPERDOMAIN' | 'DOMAIN' | 'SUBDOMAIN' | 'INFRADOMAIN' | 'EMPIRE' | 'REALM' | 'SUBREALM' | 'SUPERKINGDOM' | 'KINGDOM' | 'SUBKINGDOM' | 'INFRAKINGDOM' | 'SUPERPHYLUM' | 'PHYLUM' | 'SUBPHYLUM' | 'INFRAPHYLUM' | 'PARVPHYLUM' | 'MICROPHYLUM' | 'NANOPHYLUM' | 'CLAUDIUS' | 'GIGACLASS' | 'MEGACLASS' | 'SUPERCLASS' | 'CLASS' | 'SUBCLASS' | 'INFRACLASS' | 'SUBTERCLASS' | 'PARVCLASS' | 'SUPERDIVISION' | 'DIVISION' | 'SUBDIVISION' | 'INFRADIVISION' | 'SUPERLEGION' | 'LEGION' | 'SUBLEGION' | 'INFRALEGION' | 'MEGACOHORT' | 'SUPERCOHORT' | 'COHORT' | 'SUBCOHORT' | 'INFRACOHORT' | 'GIGAORDER' | 'MAGNORDER' | 'GRANDORDER' | 'MIRORDER' | 'SUPERORDER' | 'ORDER' | 'NANORDER' | 'HYPOORDER' | 'MINORDER' | 'SUBORDER' | 'INFRAORDER' | 'PARVORDER' | 'SUPERSECTION_ZOOLOGY' | 'SECTION_ZOOLOGY' | 'SUBSECTION_ZOOLOGY' | 'SUPERSERIES_ZOOLOGY' | 'SERIES_ZOOLOGY' | 'SUBSERIES_ZOOLOGY' | 'FALANX' | 'GIGAFAMILY' | 'MEGAFAMILY' | 'GRANDFAMILY' | 'SUPERFAMILY' | 'EPIFAMILY' | 'FAMILY' | 'SUBFAMILY' | 'INFRAFAMILY' | 'SUPERTRIBE' | 'TRIBE' | 'SUBTRIBE' | 'INFRATRIBE' | 'SUPRAGENERIC_NAME' | 'SUPERGENUS' | 'GENUS' | 'SUBGENUS' | 'INFRAGENUS' | 'SUPERSECTION_BOTANY' | 'SECTION_BOTANY' | 'SUBSECTION_BOTANY' | 'SUPERSERIES_BOTANY' | 'SERIES_BOTANY' | 'SUBSERIES_BOTANY' | 'INFRAGENERIC_NAME' | 'SPECIES_AGGREGATE' | 'SPECIES' | 'INFRASPECIFIC_NAME' | 'GREX' | 'KLEPTON' | 'SUBSPECIES' | 'CULTIVAR_GROUP' | 'CONVARIETY' | 'INFRASUBSPECIFIC_NAME' | 'PROLES' | 'NATIO' | 'ABERRATION' | 'MORPH' | 'SUPERVARIETY' | 'VARIETY' | 'SUBVARIETY' | 'SUPERFORM' | 'FORM' | 'SUBFORM' | 'PATHOVAR' | 'BIOVAR' | 'CHEMOVAR' | 'MORPHOVAR' | 'PHAGOVAR' | 'SEROVAR' | 'CHEMOFORM' | 'FORMA_SPECIALIS' | 'LUSUS' | 'CULTIVAR' | 'MUTATIO' | 'STRAIN' | 'OTHER' | 'UNRANKED'

Filters by taxonomic rank. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:taxonRank'>taxonRank</a> for more details

verbatimTaxonRankstring

Filters by taxonomic rank. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:verbatimTaxonRank'>verbatimTaxonRank</a> for more details

genericNamestring

Generic part of the name to match when given as atomised parts instead of the full name parameter.See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:genericName'>genericName</a> for more details

specificEpithetstring

Specific epithet to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:specificEpithet'>specificEpithet</a> for more details

infraspecificEpithetstring

Infraspecific epithet to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:infraspecificEpithet'>infraspecificEpithet</a> for more details

kingdomstring

Kingdom to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:kingdom'>kingdom</a> for more details

phylumstring

Phylum to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:phylum'>phylum</a> for more details

orderstring

Order to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:order'>order</a> for more details

superfamilystring

Superfamily to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:superfamily'>superfamily</a> for more details

familystring

Family to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:family'>family</a> for more details

subfamilystring

Subfamily to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:subfamily'>subfamily</a> for more details

tribestring

Tribe to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:tribe'>tribe</a> for more details

subtribestring

Subtribe to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:subtribe'>subtribe</a> for more details

genusstring

Genus to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:genus'>genus</a> for more details

subgenusstring

Subgenus to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:subgenus'>subgenus</a> for more details

speciesstring

Species to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:species'>species</a> for more details

excludestring

An array of usage keys to exclude from the match.

strictboolean

If set to true, fuzzy matches only the given name, but never a taxon in the upper classification.

verboseboolean

If set to true, it shows alternative matches which were considered but then rejected.

checklistKeystring uuid

The dataset key of the checklist to match against.

classstring

Class to match. See Darwin core term <a href='https://dwc.tdwg.org/terms/#dwc:class'>class</a> for more details

Response

Name usage suggestions found

synonymboolean

If the matched usage is a synonym

leftinteger

The left ID of the nested set

rightinteger

The right ID of the nested set