How to retrieve and view masked data in Dropbox Sign
Updated Aug 13, 2026
In this article
The information in this article applies to admins on the Dropbox Sign Premium plan.
You can use masked fields to hide sensitive signer information. All masked field information will be hidden and replaced by asterisks (e.g. *****) on callback events displayed in the API Dashboard. This article explains how to retrieve and view this masked data.
How to view masked data
There are three ways to view masked data:
Download the document data as a CSV
By downloading the document data as a CSV, you’ll receive an excel sheet with information about the signature request with values of all fields, including masked fields. Learn how to download documents as a CSV.
Note: By default, only admins can download document data as a CSV. However, admins can allow senders to download document data as a CSV.
Execute a request to the Get Signature Endpoint
Executing a request to the Get Signature Request endpoint will return a response object with unmasked values. To do this:
- Log in to app.sign.dropbox.com.
- Navigate to the Get Signature Request endpoint page.
- Click Try it at the top of the page.
- Enter your API key under Security.
- Click Parameters.
- Enter the signature_request_id of the signature request with masked fields.
- Click Send.
Note: The field with the masked data will include “masked”:true to indicate which clear value responses are masked on the document.
View the callback response objects
You can view unmasked values for masked fields in the callback event response objects that report to any callback URLs set on your account. This option allows you to process the information within your workflow.
Notes:
- If you’d prefer to receive redacted values in the callback response objects by default, follow these instructions to submit a request with Dropbox Support.
- For more information regarding callback events, please see our Events and Callbacks Guide.
Viewing masked data from the API Dashboard: an example
Here’s a response body from a callback event posted on the API Dashboard where the data is masked with asterisks:
- "value": "*********"
{
"event": {
"event_type":"signature_request_signed",
"event_time":"1609432599",
"event_hash":"5118da82b71d394887382d21e2488ae7a029d7ab",
"event_metadata": {
"related_signature_id":"d91adbb59792d036264057",
"reported_for_account_id":"f0899a9b5354b22b6cc6b301",
"reported_for_app_id":"d8754524aaa29c3025bd3"
}
},
"account_guid":"f0899a9b5354b24263252b6cc6b301",
"client_id":"d8754524aaa6129c3025bd3",
"signature_request": {
"signature_request_id":"aaf05626ad486775234c3e4043",
"test_mode": true,
"title":"test masked SSN",
"original_title":"masked SSN",
"subject":"masked SSN",
"message": null,
"metadata": {
"signed_on_domain":"localhost"
},
"created_at": 1609432502,
"is_complete": false,
"is_declined": false,
"has_error": false,
"custom_fields":[],
"response_data":[{
"name":"Signature1",
"type":"signature",
"required": true,
"api_id":"97f86e0633f7",
"value": null,
"signature_id":"d91adbb597920fcd036264057"
},
{
"name":"Masked SSN Field",
"type":"text",
"required": true,
"api_id":"acf4bb6fd352",
"value":"*********",
"signature_id":"d91adbb59792fcd036264057"
}
],
"signing_url": null,
"signing_redirect_url": null,
"final_copy_uri":"/v3/signature_request/final_copy/aaf05626a1fafa35234c3e4043",
"files_url":"https://api.hellosign.com/v3/signature_request/files/aaf05626ad486775234c3e4043",
"details_url":"https://app.hellosign.com/home/manage?guid=aaf05626ad486775234c3e4043",
"requester_email_address":"jack@example.com",
"signatures":[{
"signature_id":"d91adbb5979d036264057",
"has_pin": false,
"has_sms_auth": false,
"signer_email_address":"jill@example.com",
"signer_name":"Jill",
"signer_role": 1,
"order": null,
"status_code":"signed",
"signed_at": 1609432599,
"last_viewed_at": 1609432578,
"last_reminded_at": null,
"error": null
}],
"cc_email_addresses":[],
"template_ids": [
"7b3d2693ad423a39a2dd104"
],
"client_id":"d8754524aaa6129c3025bd3"
}
} Below is the response body after executing the Get Signature Request endpoint using the correlated signature_request_id. This exposes the masked data.
- "value": "123-45-6789"
{
"signature_request": {
"signature_request_id": "aaf05626ad486775234c3e4043",
"test_mode": true,
"title": "test masked SSN",
"original_title": "masked SSN",
"subject": "masked SSN",
"message": null,
"metadata": {
"signed_on_domain": "localhost"
},
"created_at": 1609432502,
"is_complete": true,
"is_declined": false,
"has_error": false,
"custom_fields": [ ],
"response_data": [{
"name": "Signature1",
"type": "signature",
"required": true,
"api_id": "97f86e0633f7",
"value": null,
"signature_id": "d91adbb597920fcd036264057"
},
{
"name": "Masked SSN Field",
"type": "text",
"required": true,
"api_id": "e2b418c6-2498-44af-b73f-acf4bb6fd352",
"value": "123-45-6789",
"signature_id": "d91adbb59792fcd036264057"
"masked": true
}
],
"signing_url": null,
"signing_redirect_url": null,
"final_copy_uri": "/v3/signature_request/final_copy/aaf05626a1fafa35234c3e4043",
"files_url": "https://api.hellosign.com/v3/signature_request/files/aaf05626a1fafa35234c3e4043",
"details_url": "https://app.hellosign.com/home/manage?guid=aaf05626a1fafa35234c3e4043",
"requester_email_address": "hazem.hamed@hellosign.com",
"signatures": [{
"signature_id": "d91adbb5979d036264057",
"has_pin": false,
"has_sms_auth": false,
"signer_email_address": "jhondoe1@test.com",
"signer_name": "John Doe",
"signer_role": 1,
"order": null,
"status_code": "signed",
"signed_at": 1609432599,
"last_viewed_at": 1609432578,
"last_reminded_at": null,
"error": null
}],
"cc_email_addresses": [],
"template_ids": [
"7b3d2693ad423a39a2dd104"
],
"client_id": "d8754524aaa6129c3025bd3"
}
}Community answers
-
Posted by: Brock A.1 361 days ago
289
3
-
Posted by: Neal 399 days ago
743
0
-
Posted by: Neal 399 days ago
598
0
-
Posted by: Graham 427 days ago
6712
4
-
Posted by: a600tw 543 days ago
91
1
