Get a recipient's signing URL
curl --request POST \
--url https://my.flowsign.app/api/v1/packages/{packageId}/signing-url \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipientEmail": "jsmith@example.com"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({recipientEmail: 'jsmith@example.com'})
};
fetch('https://my.flowsign.app/api/v1/packages/{packageId}/signing-url', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/packages/{packageId}/signing-url"
payload = { "recipientEmail": "jsmith@example.com" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/packages/{packageId}/signing-url");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"recipientEmail\": \"jsmith@example.com\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"signingUrl": "<string>",
"embeddedUrl": "<string>",
"sessionId": "<string>",
"recipientName": "<string>",
"recipientEmail": "<string>",
"status": "WAITING"
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Packages
Get a recipient's signing URL
Returns the signing URL for the recipient’s active session, for signing inside your own product. embeddedUrl is the same page without FlowSign’s surrounding chrome, for an iframe. An in-person recipient gets the host’s URL and no embeddedUrl. 404 when the recipient has no active session, which includes a recipient whose turn has not come yet. Requires canSendPackages.
POST
/
api
/
v1
/
packages
/
{packageId}
/
signing-url
Get a recipient's signing URL
curl --request POST \
--url https://my.flowsign.app/api/v1/packages/{packageId}/signing-url \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipientEmail": "jsmith@example.com"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({recipientEmail: 'jsmith@example.com'})
};
fetch('https://my.flowsign.app/api/v1/packages/{packageId}/signing-url', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.flowsign.app/api/v1/packages/{packageId}/signing-url"
payload = { "recipientEmail": "jsmith@example.com" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://my.flowsign.app/api/v1/packages/{packageId}/signing-url");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"recipientEmail\": \"jsmith@example.com\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
{
"data": {
"signingUrl": "<string>",
"embeddedUrl": "<string>",
"sessionId": "<string>",
"recipientName": "<string>",
"recipientEmail": "<string>",
"status": "WAITING"
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>",
"details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The workspace to act in, from GET /api/v1/workspaces. Omit to act in the organisation's default workspace. A workspace the key's user cannot act in is treated as omitted.
Path Parameters
Body
application/json
Response
Success
Show child attributes
Show child attributes
Was this page helpful?

