v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
DIR References

List a DIR's references

List the business and financial references submitted for a DIR.

Returns the two business references (slots 1 and 2) followed by the single financial reference. Each entry carries its ref_type and slot, which together address the reference when updating it, alongside the details supplied when it was submitted (name, title, organization, relationship, phone, email, timezone). No internal identifiers are exposed. Returns an empty list when no references were submitted.

get/dir/{dir_id}/references

Path parameters

dir_idstring uuid required
Example:16635d38-75a6-4481-82e8-69af60e05011

The DIR id. Lowercase UUID.

Response

The DIR's references.

Example response

{
  "data": [
    {
      "email": "dana.reyes@example.com",
      "full_name": "Dana Reyes",
      "job_title": "VP of Operations",
      "organization": "Acme Logistics",
      "phone_e164": "+14155550123",
      "record_type": "dir_reference",
      "ref_type": "business",
      "relationship_to_registrant": "Supplier",
      "slot": 1,
      "timezone": "America/New_York"
    }
  ]
}