External IDs & Metadata

Connect Undersign requests with records in your own application using an external ID, and add extra context with metadata.

External IDs

external_id associates an Undersign request with a record in your system, an order, customer or document reference:

JSON

"external_id": "ORDER-99281"

When you later retrieve the request's status, the returned data.external_id lets you match it back to your own record.

metadata is an extensible object for additional application context. The keys you supply are application-specific:

JSON

"metadata": {
  "crm_id": "003AJ00000KxA",
  "order_number": "ORD-99281",
  "department": "Home Loans"
}

There are no mandatory metadata keys, supply whatever context your integration needs, and it is returned with the request.

The metadata data model reference.

Create a request with external IDs, metadata and more.