Skip to content

Capabilities

Read an authorized company's saved business profile

Read saved legal company details for forms and vendor questionnaires: legal name, entity type, formation date and jurisdiction, saved business/tax-filing address, full business contact email and phone, members, the latest W-9 signer, and dated compliance-binder evidence with source links even when the profile is blank. Choose user for your own business, organization with its ID, or platform for Endurance HQ's separate company (platform admins only). For user scope, supply binderOrganizationId to read an explicitly selected organization binder; organization/platform scope uses its own binder. Document evidence is separately authorized, may describe historical filings or a different entity, and never silently fills profile fields. Requires a user-bound credential with capabilities:read and current business-profile and selected-binder management access. Missing fields remain null; never infer officer authority from ownership or prior vendor NDA/PaaS history from absent records. Does not return structured tax IDs, signature images or private storage URLs. Excerpts redact formatted tax identifiers; source links use the authenticated binder route. Does not write or send a form.

Method

GET

Path

/v1/business-profile

Required scope

capabilities:read

Request

curl -X GET "https://api.endurancehq.app/v1/business-profile" \
  -H "Authorization: Bearer $EHQ_API_KEY"

Query schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scopeType": {
      "type": "string",
      "enum": [
        "user",
        "organization",
        "platform"
      ],
      "description": "user is your own business; organization requires scopeId; platform is Endurance HQ and requires platform-admin access."
    },
    "scopeId": {
      "description": "Organization ID only. Personal business identity always comes from the authenticated user.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "binderOrganizationId": {
      "description": "For user scope only: explicitly select an organization holding this business's documents. Its separate binder-management permission is checked. This does not assert that the organization and personal profile are the same company.",
      "type": "string",
      "maxLength": 200,
      "format": "starts_with",
      "pattern": "^org_.*"
    },
    "documentQuery": {
      "description": "Optional search within the selected authorized binder, for example articles, address, officer, or amendments.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "scopeType"
  ],
  "additionalProperties": false
}

Response

Success status: 200

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "retrievedAt": {
          "type": "string"
        },
        "profile": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "scopeType": {
                  "type": "string",
                  "enum": [
                    "user",
                    "organization",
                    "platform"
                  ]
                },
                "scopeId": {
                  "type": "string"
                },
                "legalName": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "entityType": {
                  "type": "string"
                },
                "formation": {
                  "type": "object",
                  "properties": {
                    "country": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "state": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "date": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "country",
                    "state",
                    "date"
                  ],
                  "additionalProperties": false
                },
                "address": {
                  "type": "object",
                  "properties": {
                    "line1": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "line2": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "city": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "state": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "postalCode": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "country": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "line1",
                    "line2",
                    "city",
                    "state",
                    "postalCode",
                    "country"
                  ],
                  "additionalProperties": false
                },
                "contact": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "email": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "phone": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "name",
                    "email",
                    "phone"
                  ],
                  "additionalProperties": false
                },
                "members": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string"
                      },
                      "ownershipPct": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "name",
                      "ownershipPct"
                    ],
                    "additionalProperties": false
                  }
                },
                "source": {
                  "type": "object",
                  "properties": {
                    "table": {
                      "type": "string",
                      "const": "tax_profiles"
                    },
                    "id": {
                      "type": "string"
                    },
                    "updatedAt": {
                      "type": "string"
                    },
                    "timestampType": {
                      "type": "string",
                      "const": "timestamp without time zone"
                    }
                  },
                  "required": [
                    "table",
                    "id",
                    "updatedAt",
                    "timestampType"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "scopeType",
                "scopeId",
                "legalName",
                "entityType",
                "formation",
                "address",
                "contact",
                "members",
                "source"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "latestSignedW9": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "signatureName": {
                  "type": "string"
                },
                "signatureTitle": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "signedDate": {
                  "type": "string"
                },
                "isCurrent": {
                  "type": "boolean"
                },
                "source": {
                  "type": "object",
                  "properties": {
                    "table": {
                      "type": "string",
                      "const": "business_w9_documents"
                    },
                    "id": {
                      "type": "string"
                    },
                    "signedAt": {
                      "type": "string"
                    },
                    "profileUpdatedAt": {
                      "type": "string"
                    },
                    "timestampType": {
                      "type": "string",
                      "const": "timestamp without time zone"
                    }
                  },
                  "required": [
                    "table",
                    "id",
                    "signedAt",
                    "profileUpdatedAt",
                    "timestampType"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "signatureName",
                "signatureTitle",
                "signedDate",
                "isCurrent",
                "source"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "binderEvidence": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "organizationId": {
                  "type": "string"
                },
                "hasMoreDocuments": {
                  "type": "boolean"
                },
                "documents": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "title": {
                        "type": "string"
                      },
                      "documentType": {
                        "type": "string"
                      },
                      "category": {
                        "type": "string"
                      },
                      "status": {
                        "type": "string"
                      },
                      "issuedAt": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "effectiveAt": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "expiresAt": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "extractionStatus": {
                        "type": "string"
                      },
                      "extractedAt": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "extractionMethod": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "excerpts": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "url": {
                        "type": "string"
                      },
                      "source": {
                        "type": "object",
                        "properties": {
                          "table": {
                            "type": "string",
                            "const": "organization_compliance_documents"
                          },
                          "id": {
                            "type": "string"
                          },
                          "organizationId": {
                            "type": "string"
                          },
                          "updatedAt": {
                            "type": "string"
                          },
                          "timestampType": {
                            "type": "string",
                            "const": "timestamp without time zone"
                          }
                        },
                        "required": [
                          "table",
                          "id",
                          "organizationId",
                          "updatedAt",
                          "timestampType"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "required": [
                      "id",
                      "title",
                      "documentType",
                      "category",
                      "status",
                      "issuedAt",
                      "effectiveAt",
                      "expiresAt",
                      "extractionStatus",
                      "extractedAt",
                      "extractionMethod",
                      "excerpts",
                      "url",
                      "source"
                    ],
                    "additionalProperties": false
                  }
                },
                "guidance": {
                  "type": "string"
                }
              },
              "required": [
                "organizationId",
                "hasMoreDocuments",
                "documents",
                "guidance"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "note": {
          "type": "string"
        }
      },
      "required": [
        "retrievedAt",
        "profile",
        "latestSignedW9",
        "binderEvidence",
        "note"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Other surfaces

MCP tool: ehq_business_profile_get