SignRequest (förhandsversion)

SignRequest är ett säkert och juridiskt bindande e-signaturverktyg som gör att du och dina partner kan signera kontrakt och andra dokument snabbt och utan att behöva skriva ut, signera och skanna.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande:      – Azure Government-regioner      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)

Kontakt
E-postmeddelande	tech-support@signrequest.com

Metadata för anslutningsprogram
Utgivare	SignRequest B.V.

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Skicka SignRequest

Skapar och skickar en ny SignRequest.

Skicka SignRequest

Åtgärds-ID:

SignrequestQuickCreateCreate

Skapar och skickar en ny SignRequest.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Dagar för automatisk borttagning	auto_delete_days		integer	Antal dagar efter vilket ett färdigt dokument (signerat/avbrutet/nekat) tas bort automatiskt
Förfalla dagar automatiskt	auto_expire_days		integer	Antal dagar efter vilket ett dokument som inte är färdigt upphör att gälla automatiskt
Inaktivera bifogade filer	disable_attachments		boolean	Inaktivera uppladdning/tillägg av bifogade filer
Inaktivera blockkedjebevis	disable_blockchain_proof		boolean	Inaktiverar lagring av tidsstämpelsäkra hashvärden i blockkedjeintegreringar.
Inaktivera datum	disable_date		boolean	Inaktivera tillägg av datum
Inaktivera e-postmeddelanden	disable_emails		boolean	Inaktivera alla e-postmeddelanden om SignRequest-status samt e-postmeddelandet som innehåller de signerade dokumenten
Inaktivera text	disable_text		boolean	Inaktivera tillägg av text
Inaktivera textsignaturer	disable_text_signatures		boolean	Inaktivera användning av signaturer som genereras genom att skriva (text)
Inaktivera uppladdningssignaturer	disable_upload_signatures		boolean	Inaktivera användning av uppladdade signaturer (bilder)
Dokument	document		uri
Url för återanrop av händelser	events_callback_url		uri	URL som du vill ta emot händelseåteranrop till för det här dokumentet
Externt ID	external_id		string	ID som används för att referera till dokument i ett externt system
File	file		uri	Tillfällig URL till originalfil, upphör att gälla om fem minuter
Fil från innehåll	file_from_content		byte	Base64-kodat dokumentinnehåll
Fil från innehållsnamn	file_from_content_name		string	Filnamn, inklusive tillägg. Krävs när du använder file_from_content.
Fil från URL	file_from_url		uri	Offentligt tillgänglig URL för dokument som ska laddas ned av SignRequest
Från e-post	from_email		email	E-post för användare som skickar SignRequest (måste vara ett validerat e-postmeddelande)
Från e-postnamn	from_email_name		string	Namn som ska användas i e-postrubriken From , t.ex. {from_email_name} <no-reply@signrequest.com>
Klientdels-ID	frontend_id		string	Delad hemlighet som används tillsammans med SignRequest-js-klienten för att ge användaren åtkomst till ett dokument som inte är medlem i dokumentets team
Håller på att förberedas	is_being_prepared		boolean	Be avsändaren av en SignRequest att förbereda dokumentet innan du skickar ut begäran. Se: förbereda med hjälp av webbgränssnittet
Message	message		string	Meddelandet som ska inkluderas i SignRequest-e-postmeddelandet kan innehålla följande html-taggar: a, abbr, acronym, b, blockquote, codeem, i, ulli, och olstrong
Namn	name		string	Standardinställningar för filnamn, inklusive tillägg
Kryssrutavärde för förfyllningstaggar	checkbox_value		boolean
Datumvärde för förfyllningstaggar	date_value		date
Externt ID för förfyllningstaggar	external_id		string
Text för ifyllningstaggar	text		string
Förbereda url	prepare_url		uri
Omdirigerings-URL	redirect_url		uri	URL som SignRequest omdirigeras till när ett dokument signeras
Omdirigerings-URL nekades	redirect_url_declined		uri	URL där SignRequest omdirigeras till när ett dokument avvisas
Obligatoriskt namn på bifogad fil	name	True	string
Nödvändig bifogad fil uuid	uuid		string
Skicka påminnelser	send_reminders		boolean	Påminn undertecknare automatiskt om att signera ett dokument. Se: automatiska påminnelser
Undertecknare efter dokument	after_document		uri
Endast undertecknaren godkänner	approve_only		boolean	Kräv att användaren godkänner dokumentet (utan att lägga till en signatur), se: Godkänn endast
File	file		uri
Obligatoriskt namn på bifogad fil	name	True	string
Nödvändig bifogad fil uuid	uuid		string
Namn	name		string	Standardinställningar för filnamn
Uuid	uuid		string
Undertecknaren nekades	declined		boolean
Undertecknaren nekades	declined_on		date-time
Visningsnamn för undertecknare	display_name		string
Undertecknaren har laddats ned	downloaded		boolean
E-post för undertecknare	email	True	email
Signerarens e-post visas	email_viewed		boolean
Undertecknaren har skickats via e-post	emailed		boolean
Inbäddnings-URL för undertecknare	embed_url		uri
Användar-ID för inloggnings-URL	embed_url_user_id		string
Undertecknarens förnamn	first_name		string
Signer Force Language	force_language		boolean
Vidarebefordrad undertecknare	forwarded		boolean
Undertecknaren vidarebefordras på	forwarded_on		date-time
Vidarebefordrad orsak för undertecknare	forwarded_reason		string
Undertecknaren vidarebefordras till e-post	forwarded_to_email		email
Inloggningsperson	in_person		boolean	När de används i kombination med en inbäddnings-URL på avsändaren, när avsändaren har signerats, omdirigeras de till nästa in_person undertecknare. Se: Personlig signering
Kryssrutevärde	checkbox_value		boolean
Datumvärde	date_value		date
Externt ID	external_id		string
Sidindex	page_index	True	integer
Platshållare uuid	placeholder_uuid		string
Text	text		string
Typ	type		string
Språk för undertecknare	language		string
Undertecknarens efternamn	last_name		string
Undertecknarmeddelande	message		string
Undertecknaren måste signera	needs_to_sign		boolean	När false användaren inte behöver signera, men får en kopia av det signerade dokumentet och signeringsloggen, se: Kopiera endast
Meddela endast undertecknare	notify_only		boolean	Skicka meddelanden om dokumentet och en kopia av det signerade dokumentet och signeringsloggen, men kräv inte att de vidtar några åtgärder. Mer information finns i: Meddela endast
Undertecknarbeställning	order		integer
Lösenord för undertecknare	password		string	Kräv att undertecknaren anger det här lösenordet innan du signerar ett dokument. Det här fältet är skrivskyddat.
Omdirigerings-URL för undertecknare	redirect_url		uri
Omdirigerings-URL för undertecknare nekades	redirect_url_declined		uri
Signerad undertecknare	signed		boolean
Signerad	signed_on		date-time
Undertecknaren använder endast stämpel för godkännande	use_stamp_for_approve_only		boolean	Placera en godkännandestämpel på ett dokument när en undertecknare godkänner ett dokument
Verifiera bankkonto för undertecknare	verify_bank_account		string
Verifiera telefonnummer för undertecknare	verify_phone_number		string
Signerad	viewed		boolean
Grupp	subdomain		string
Ämne	subject		string	Ämne för SignRequest-e-post
Template	template		uri
Verifiering av sms låst	text_message_verification_locked		boolean	När sant krävs en textmeddelandeverifiering innan undertecknaren kan se dokumentet
URL	url		uri
Uuid	uuid		string
Vem	who		string	m: bara jag, mo: mig och andra, o: bara andra

Returer

Body

SignRequestQuickCreate

Utlösare

När ett dokuments status ändras

Utlöses när dokumentstatusen för en SignRequest ändras.

När ett dokuments status ändras

Åtgärds-ID:

WebhooksCreate

Utlöses när dokumentstatusen för en SignRequest ändras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Skapades	created		date-time
Händelsetyp	event_type	True	string
Namn	name		string	Valfritt namn för att enkelt identifiera vilken webhook som används för
Grupp	subdomain		string
Gruppnamn	name		string
Teamunderdomän	subdomain		uri
Grupp-URL	url		uri
URL	url		uri
Uuid	uuid		string

Returer

Name	Sökväg	Typ	Description
dokument	document	Document

Definitioner

Dokument

Name	Sökväg	Typ	Description
Dokument-API används	api_used	boolean	Anger om dokumentet skapades med hjälp av API:et
attachments	attachments	array of DocumentAttachment
Ta bort automatiskt dokument efter	auto_delete_after	date-time	Datum och tid som beräknas med hjälp av auto_delete_days varefter ett färdigt dokument (signerat/avbrutet/nekat) tas bort automatiskt
Dagar för automatisk borttagning av dokument	auto_delete_days	integer	Antal dagar efter vilket ett färdigt dokument (signerat/avbrutet/nekat) tas bort automatiskt
Dokumentet upphör automatiskt att gälla efter	auto_expire_after	date-time	Datum och tid som beräknas med hjälp av auto_expire_days varefter ett icke färdigt dokument automatiskt upphör att gälla
Dokument förfaller automatiskt dagar	auto_expire_days	integer	Antal dagar efter vilket ett dokument som inte är färdigt upphör att gälla automatiskt
Url för återanrop till dokumenthändelser	events_callback_url	uri	URL som du vill ta emot händelseåteranrop till för det här dokumentet
Dokument, externt ID	external_id	string	ID som används för att referera till dokument i ett externt system
Dokumentfil	file	uri	Tillfällig URL till originalfil, upphör att gälla om fem minuter
Dokumentfil som pdf	file_as_pdf	uri	Tillfällig URL till den ursprungliga filen som PDF upphör att gälla om fem minuter
Dokumentfil från innehåll	file_from_content	string	Base64-kodat dokumentinnehåll
Dokumentfil från innehållsnamn	file_from_content_name	string	Filnamn, inklusive tillägg. Krävs när du använder file_from_content.
Fil från sf	file_from_sf	FileFromSf
Dokumentfil från URL	file_from_url	uri	Offentligt tillgänglig URL för dokument som ska laddas ned av SignRequest
Dokumentklientdels-ID	frontend_id	string	Delad hemlighet som används tillsammans med SignRequest-js-klienten för att ge användaren åtkomst till ett dokument som inte är medlem i dokumentets team
Dokumentnamn	name	string	Standardinställningar för filnamn, inklusive tillägg
Pdf-dokument	pdf	uri	Tillfällig URL till signerat dokument som PDF upphör att gälla om fem minuter
prefill_tags	prefill_tags	array of InlinePrefillTags	Indata för förfyllnadssignerare, se förifyllningstaggar
Dokumentbearbetning	processing	boolean	Anger om en ändring av dokumentet bearbetas och PDF-filen kan vara inaktuell. Vi rekommenderar att du väntar tills bearbetningen är klar innan du laddar ned PDF-filen. Webhooks skickas inte förrän bearbetningen har slutförts.
Sandbox-miljö för dokument	sandbox	boolean	Anger om dokumentet skapades som en del av ett sandbox-team
Hash för dokumentsäkerhet	security_hash	string	SHA256-hash av PDF-innehåll
Pdf för signeringslogg	signing_log.pdf	uri	Tillfällig URL till signeringsloggen upphör att gälla om fem minuter
Säkerhetshash för signeringslogg	signing_log.security_hash	string	SHA256-hash av PDF-innehåll
Inaktivera bifogade filer för signrequest	signrequest.disable_attachments	boolean	Inaktivera uppladdning/tillägg av bifogade filer
Signrequest Inaktivera blockkedjebevis	signrequest.disable_blockchain_proof	boolean	Inaktiverar lagring av tidsstämpelsäkra hashvärden i blockkedjeintegreringar.
Inaktivera datum för signrequest	signrequest.disable_date	boolean	Inaktivera tillägg av datum
Inaktivera e-postmeddelanden för signrequest	signrequest.disable_emails	boolean	Inaktivera alla e-postmeddelanden om SignRequest-status samt e-postmeddelandet som innehåller de signerade dokumenten
Inaktivera text för signrequest	signrequest.disable_text	boolean	Inaktivera tillägg av text
Signrequest Inaktivera textsignaturer	signrequest.disable_text_signatures	boolean	Inaktivera användning av signaturer som genereras genom att skriva (text)
Signrequest Inaktivera uppladdningssignaturer	signrequest.disable_upload_signatures	boolean	Inaktivera användning av uppladdade signaturer (bilder)
Signrequest från e-post	signrequest.from_email	email	E-post för användare som skickar SignRequest (måste vara ett validerat e-postmeddelande)
Signrequest från e-postnamn	signrequest.from_email_name	string	Namn som ska användas i e-postrubriken From , t.ex. {from_email_name} <no-reply@signrequest.com>
Signrequest förbereds	signrequest.is_being_prepared	boolean	Be avsändaren av en SignRequest att förbereda dokumentet innan du skickar ut begäran. Se: förbereda med hjälp av webbgränssnittet
Signrequest-meddelande	signrequest.message	string	Meddelandet som ska inkluderas i SignRequest-e-postmeddelandet kan innehålla följande html-taggar: a, abbr, acronym, b, blockquote, codeem, i, ulli, och olstrong
Förbered URL för signrequest	signrequest.prepare_url	uri
Omdirigerings-URL för signrequest	signrequest.redirect_url	uri	URL som SignRequest omdirigeras till när ett dokument signeras
Omdirigerings-URL för signrequest nekades	signrequest.redirect_url_declined	uri	URL där SignRequest omdirigeras till när ett dokument avvisas
required_attachments	signrequest.required_attachments	array of RequiredAttachment
Skicka påminnelser för signrequest	signrequest.send_reminders	boolean	Påminn undertecknare automatiskt om att signera ett dokument. Se: automatiska påminnelser
Undertecknarna	signrequest.signers	array of Signer
Signrequest-ämne	signrequest.subject	string	Ämne för SignRequest-e-post
Verifiering av signrequest-textmeddelande låst	signrequest.text_message_verification_locked	boolean	När sant krävs en textmeddelandeverifiering innan undertecknaren kan se dokumentet
Signrequest Uuid	signrequest.uuid	string
Signrequest Vem	signrequest.who	string	m: bara jag, mo: mig och andra, o: bara andra
Dokumentstatus	status	string	co: converting, ne: new, se: sent, vi: viewed, si: signed, do: downloaded, sd: signed and downloaded, ca: cancelled, de: declined, ec: error converting, es: error sending, xp: expired
Gruppnamn	team.name	string
Teamunderdomän	team.subdomain	uri
Grupp-URL	team.url	uri
Dokumentmall	template	uri
Dokument-URL	url	uri
User	user	User
Dokument-Uuid	uuid	string

DocumentAttachment

Name	Sökväg	Typ	Description
Dokument för bifogat dokument	document	uri
Bifogad fil för dokument	file	uri	Tillfällig URL till dokumentbilaga, upphör att gälla om fem minuter
Bifogad dokumentfil från innehåll	file_from_content	string	Base64-kodat dokumentinnehåll
Bifogad dokumentfil från innehållsnamn	file_from_content_name	string	Filnamn, inklusive tillägg. Krävs när du använder file_from_content.
Bifogad dokumentfil från URL	file_from_url	uri	Offentligt tillgänglig URL för dokument som ska laddas ned av SignRequest
Namn på dokumentbilaga	name	string	Standardinställningar för filnamn, inklusive tillägg
Url för dokumentbilaga	url	uri
Dokumentbilaga Uuid	uuid	string

FileFromSf

Name	Sökväg	Typ	Description
Objekt-ID	object_id	string
Objekttyp	object_type	string
Uid	uid	string

InlinePrefillTags

Indata för förfyllnadssignerare, se förifyllningstaggar

Name	Sökväg	Typ	Description
Kryssrutavärde för förfyllningstaggar	checkbox_value	boolean
Datumvärde för förfyllningstaggar	date_value	date
Externt ID för förfyllningstaggar	external_id	string
Text för ifyllningstaggar	text	string

RequiredAttachment

Name	Sökväg	Typ	Description
Obligatoriskt namn på bifogad fil	name	string
Nödvändig bifogad fil uuid	uuid	string

SignRequestQuickSkapa

Name	Sökväg	Typ	Description
Dagar för automatisk borttagning	auto_delete_days	integer	Antal dagar efter vilket ett färdigt dokument (signerat/avbrutet/nekat) tas bort automatiskt
Förfalla dagar automatiskt	auto_expire_days	integer	Antal dagar efter vilket ett dokument som inte är färdigt upphör att gälla automatiskt
Inaktivera bifogade filer	disable_attachments	boolean	Inaktivera uppladdning/tillägg av bifogade filer
Inaktivera blockkedjebevis	disable_blockchain_proof	boolean	Inaktiverar lagring av tidsstämpelsäkra hashvärden i blockkedjeintegreringar.
Inaktivera datum	disable_date	boolean	Inaktivera tillägg av datum
Inaktivera e-postmeddelanden	disable_emails	boolean	Inaktivera alla e-postmeddelanden om SignRequest-status samt e-postmeddelandet som innehåller de signerade dokumenten
Inaktivera text	disable_text	boolean	Inaktivera tillägg av text
Inaktivera textsignaturer	disable_text_signatures	boolean	Inaktivera användning av signaturer som genereras genom att skriva (text)
Inaktivera uppladdningssignaturer	disable_upload_signatures	boolean	Inaktivera användning av uppladdade signaturer (bilder)
Dokument	document	uri
Url för återanrop av händelser	events_callback_url	uri	URL som du vill ta emot händelseåteranrop till för det här dokumentet
Externt ID	external_id	string	ID som används för att referera till dokument i ett externt system
File	file	uri	Tillfällig URL till originalfil, upphör att gälla om fem minuter
Fil från innehåll	file_from_content	byte	Base64-kodat dokumentinnehåll
Fil från innehållsnamn	file_from_content_name	string	Filnamn, inklusive tillägg. Krävs när du använder file_from_content.
Fil från URL	file_from_url	uri	Offentligt tillgänglig URL för dokument som ska laddas ned av SignRequest
Från e-post	from_email	email	E-post för användare som skickar SignRequest (måste vara ett validerat e-postmeddelande)
Från e-postnamn	from_email_name	string	Namn som ska användas i e-postrubriken From , t.ex. {from_email_name} <no-reply@signrequest.com>
Klientdels-ID	frontend_id	string	Delad hemlighet som används tillsammans med SignRequest-js-klienten för att ge användaren åtkomst till ett dokument som inte är medlem i dokumentets team
Håller på att förberedas	is_being_prepared	boolean	Be avsändaren av en SignRequest att förbereda dokumentet innan du skickar ut begäran. Se: förbereda med hjälp av webbgränssnittet
Message	message	string	Meddelandet som ska inkluderas i SignRequest-e-postmeddelandet kan innehålla följande html-taggar: a, abbr, acronym, b, blockquote, codeem, i, ulli, och olstrong
Namn	name	string	Standardinställningar för filnamn, inklusive tillägg
prefill_tags	prefill_tags	array of InlinePrefillTags	Indata för förfyllnadssignerare, se förifyllningstaggar
Förbereda url	prepare_url	uri
Omdirigerings-URL	redirect_url	uri	URL som SignRequest omdirigeras till när ett dokument signeras
Omdirigerings-URL nekades	redirect_url_declined	uri	URL där SignRequest omdirigeras till när ett dokument avvisas
required_attachments	required_attachments	array of RequiredAttachment	Bifogade filer som undertecknare måste ladda upp
Skicka påminnelser	send_reminders	boolean	Påminn undertecknare automatiskt om att signera ett dokument. Se: automatiska påminnelser
Undertecknarna	signers	array of Signer
Grupp	subdomain	string
Ämne	subject	string	Ämne för SignRequest-e-post
Template	template	uri
Verifiering av sms låst	text_message_verification_locked	boolean	När sant krävs en textmeddelandeverifiering innan undertecknaren kan se dokumentet
URL	url	uri
Uuid	uuid	string
Vem	who	string	m: bara jag, mo: mig och andra, o: bara andra

Undertecknare

Name	Sökväg	Typ	Description
Undertecknare efter dokument	after_document	uri
Endast undertecknaren godkänner	approve_only	boolean	Kräv att användaren godkänner dokumentet (utan att lägga till en signatur), se: Godkänn endast
attachments	attachments	array of SignerAttachment
Undertecknaren nekades	declined	boolean
Undertecknaren nekades	declined_on	date-time
Visningsnamn för undertecknare	display_name	string
Undertecknaren har laddats ned	downloaded	boolean
E-post för undertecknare	email	email
Signerarens e-post visas	email_viewed	boolean
Undertecknaren har skickats via e-post	emailed	boolean
Inbäddnings-URL för undertecknare	embed_url	uri
Användar-ID för inloggnings-URL	embed_url_user_id	string
Undertecknarens förnamn	first_name	string
Signer Force Language	force_language	boolean
Vidarebefordrad undertecknare	forwarded	boolean
Undertecknaren vidarebefordras på	forwarded_on	date-time
Vidarebefordrad orsak för undertecknare	forwarded_reason	string
Undertecknaren vidarebefordras till e-post	forwarded_to_email	email
Inloggningsperson	in_person	boolean	När de används i kombination med en inbäddnings-URL på avsändaren, när avsändaren har signerats, omdirigeras de till nästa in_person undertecknare. Se: Personlig signering
Ingångar	inputs	array of SignerInputs
Språk för undertecknare	language	string
Undertecknarens efternamn	last_name	string
Undertecknarmeddelande	message	string
Undertecknaren måste signera	needs_to_sign	boolean	När false användaren inte behöver signera, men får en kopia av det signerade dokumentet och signeringsloggen, se: Kopiera endast
Meddela endast undertecknare	notify_only	boolean	Skicka meddelanden om dokumentet och en kopia av det signerade dokumentet och signeringsloggen, men kräv inte att de vidtar några åtgärder. Mer information finns i: Meddela endast
Undertecknarbeställning	order	integer
Lösenord för undertecknare	password	string	Kräv att undertecknaren anger det här lösenordet innan du signerar ett dokument. Det här fältet är skrivskyddat.
Omdirigerings-URL för undertecknare	redirect_url	uri
Omdirigerings-URL för undertecknare nekades	redirect_url_declined	uri
Signerad undertecknare	signed	boolean
Signerad	signed_on	date-time
Undertecknaren använder endast stämpel för godkännande	use_stamp_for_approve_only	boolean	Placera en godkännandestämpel på ett dokument när en undertecknare godkänner ett dokument
Verifiera bankkonto för undertecknare	verify_bank_account	string
Verifiera telefonnummer för undertecknare	verify_phone_number	string
Signerad	viewed	boolean

SignerAttachment

Name	Sökväg	Typ	Description
File	file	uri
for_attachment	for_attachment	RequiredAttachment
Namn	name	string	Standardinställningar för filnamn
Uuid	uuid	string

SignerInputs

Name	Sökväg	Typ	Description
Kryssrutevärde	checkbox_value	boolean
Datumvärde	date_value	date
Externt ID	external_id	string
Sidindex	page_index	integer
Platshållare uuid	placeholder_uuid	string
Text	text	string
Typ	type	string

User

Name	Sökväg	Typ	Description
Användarens visningsnamn	display_name	string
Användarens e-postadress	email	email
Användarens förnamn	first_name	string
Användarnamn	last_name	string