/openfda/device/udi

POST /api/openfda/device/udi

Price: 1 credit

Get an FDA GUDID unique device identifier record by its UDI-DI or public device record key

How to use it

Get an FDA GUDID (Global Unique Device Identification Database) record by a UDI-DI device identifier or public device record key. Returns the brand name, company, device description, model and catalog numbers, all device identifiers, product codes with device class, GMDN terms, device sizes, sterilization info, prescription/OTC and other regulatory flags, and version dates.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — UDI-DI (device identifier) or public device record key (examples: "18059015371697", "4c95c86e-bedf-423b-80f4-da522f194cd4"; minLength: 1)

Response

• @type string (default: "OpenfdaDeviceUdi")
• public_device_record_key string required
• brand_name string nullable
• company_name string nullable
• device_description string nullable
• version_or_model_number string nullable
• catalog_number string nullable
• labeler_duns_number string nullable
• record_status string nullable
• commercial_distribution_status string nullable
• commercial_distribution_end_at integer nullable
• mri_safety string nullable
• device_count_in_base_package string nullable
• public_version_number string nullable
• public_version_status string nullable
• publish_at integer nullable
• public_version_at integer nullable
• is_rx boolean nullable
• is_otc boolean nullable
• is_kit boolean nullable
• is_combination_product boolean nullable
• is_single_use boolean nullable
• is_hct_p boolean nullable
• is_pm_exempt boolean nullable
• is_direct_marking_exempt boolean nullable
• has_expiration_date boolean nullable
• has_lot_or_batch_number boolean nullable
• has_serial_number boolean nullable
• has_manufacturing_date boolean nullable
• has_donation_id_number boolean nullable
• is_labeled_as_nrl boolean nullable
• is_labeled_as_no_nrl boolean nullable
• identifiers array (default: [])
  • @type string (default: "OpenfdaUdiIdentifier")
  • id string required
  • identifier_type string nullable
  • issuing_agency string nullable
• product_codes array (default: [])
  • @type string (default: "OpenfdaUdiProductCode")
  • code string required
  • name string nullable
  • openfda object nullable
    • @type string (default: "OpenfdaBlock")
    • application_number array (default: [])
    • brand_name array (default: [])
    • generic_name array (default: [])
    • manufacturer_name array (default: [])
    • product_ndc array (default: [])
    • package_ndc array (default: [])
    • product_type array (default: [])
    • route array (default: [])
    • substance_name array (default: [])
    • rxcui array (default: [])
    • unii array (default: [])
    • spl_id array (default: [])
    • spl_set_id array (default: [])
    • nui array (default: [])
    • pharm_class_cs array (default: [])
    • pharm_class_epc array (default: [])
    • pharm_class_moa array (default: [])
    • pharm_class_pe array (default: [])
    • is_original_packager array (default: [])
    • device_class string nullable
    • device_name string nullable
    • medical_specialty_description string nullable
    • regulation_number string nullable
    • fei_number array (default: [])
    • registration_number array (default: [])
    • k_number array (default: [])
    • pma_number array (default: [])
• gmdn_terms array (default: [])
  • @type string (default: "OpenfdaUdiGmdnTerm")
  • code string nullable
  • name string required
  • definition string nullable
  • implantable boolean nullable
  • code_status string nullable
• device_sizes array (default: [])
  • @type string (default: "OpenfdaUdiSize")
  • size_type string nullable
  • value string nullable
  • unit string nullable
• storage array (default: [])
  • @type string (default: "OpenfdaUdiStorage")
  • storage_type string nullable
  • high object nullable
    • @type string (default: "OpenfdaUdiStorageBound")
    • value string nullable
    • unit string nullable
  • low object nullable
    • @type string (default: "OpenfdaUdiStorageBound")
    • value string nullable
    • unit string nullable
  • special_conditions string nullable
• premarket_submissions array (default: [])
  • @type string (default: "OpenfdaUdiSubmission")
  • submission_number string required
  • supplement_number string nullable
• customer_contacts array (default: [])
  • @type string (default: "OpenfdaUdiContact")
  • phone string nullable
  • email string nullable
• sterilization object nullable
  • @type string (default: "OpenfdaUdiSterilization")
  • is_sterile boolean nullable
  • is_sterilization_prior_use boolean nullable
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Device record not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.