get
https://api-sandbox.urbanpayx.com/api/v1/contracts/signing-profile
Get signing profile
Returns the client's signing profile, including default signer details and
uploaded signature and initials images.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Returns your client's signing profile — the default signer identity (display name and email) used when your organization signs documents, plus the IDs of any stored signature and initials images and any default field values pre-filled at signing time. This is a read-only endpoint with no side effects.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
contracts.signing_profile.readpermission and have the OWNER, OPERATIONS, or DEVELOPER role. - Contract signing must be enabled for your client. If it is disabled the request returns
403.
Response
200 — Returns the signing profile object:
| Field | Description |
|---|---|
id | Unique signing profile ID |
display_name | Display name shown on signed documents |
signer_email | Email address used for the client's signing identity |
signature_file_id | ID of the stored signature image file, or null if none |
initials_file_id | ID of the stored initials image file, or null if none |
default_fields | Default field values pre-filled when your organization signs a document |
created_at | Timestamp when the signing profile was created |
updated_at | Timestamp when the signing profile was last updated |
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for this client |
404 | No signing profile exists for this client yet |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.