Sometimes you may want to search for electronic signatures of different types simultaneously GroupDocs.Signature Cloud allows searching documents for different signature types in an easy and intuitive way. In common words the idea is to pass collection of desired signature types to Search method.
API usage
There are steps that usage of GroupDocs.Signature Cloud consists of:
Upload input document into cloud storage
Search signatures
For storage operations, like uploading or downloading documents, please refer to the corresponding articles of this manual.
Swagger UI lets you call this REST API directly from the browser.
cURL example
# Get JSON Web Token# Place your client ID and client secret in the CLIENT_ID and CLIENT_SECRET environment variables.curl -v "https://api.groupdocs.cloud/connect/token"\
-X POST \
-d "grant_type=client_credentials&client_id=$CLIENT_ID&client_secret=$CLIENT_SECRET"\
-H "Content-Type: application/x-www-form-urlencoded"\
-H "Accept: application/json"# Get document signature information# The JWT token must be stored in the JWT_TOKEN environment variable.curl -v "https://api.groupdocs.cloud/v2.0/signature/search"\
-X POST \
-H "Content-Type: application/json"\
-H "Accept: application/json"\
-H "Authorization: Bearer $JWT_TOKEN"\
-d '{
"FileInfo": {
"FilePath": "signaturedocs/signedCollectionsOne_page.docx"
},
"Options": [
{
"AllPages": true,
"SignatureType": "Barcode"
},
{
"AllPages": true,
"SignatureType": "QRCode"
}
]
}'
# Get JSON Web Token# Ensure CLIENT_ID and CLIENT_SECRET are set in your environment.curl.exe-v"https://api.groupdocs.cloud/connect/token"`-XPOST`-d"grant_type=client_credentials&client_id=$env:CLIENT_ID&client_secret=$env:CLIENT_SECRET"`-H"Content-Type: application/x-www-form-urlencoded"`-H"Accept: application/json"# Get document signature information# Ensure JWT_TOKEN is set in your environment.curl.exe-v"https://api.groupdocs.cloud/v2.0/signature/search"`-XPOST`-H"Content-Type: application/json"`-H"Accept: application/json"`-H"Authorization: Bearer $env:JWT_TOKEN"`-d"{
'FileInfo': {
'FilePath': 'signaturedocs/signedCollectionsOne_page.docx'
},
'Options': [
{ 'AllPages': true, 'SignatureType': 'Barcode' },
{ 'AllPages': true, 'SignatureType': 'QRCode' }
]
}"
rem Get JSON Web Tokenrem Ensure CLIENT_ID and CLIENT_SECRET are set as environment variables.curl -v "https://api.groupdocs.cloud/connect/token"^
-X POST ^
-d "grant_type=client_credentials&client_id=%CLIENT_ID%&client_secret=%CLIENT_SECRET%"^
-H "Content-Type: application/x-www-form-urlencoded"^
-H "Accept: application/json"rem Get document signature informationrem Ensure JWT_TOKEN is set as an environment variable.curl -v "https://api.groupdocs.cloud/v2.0/signature/search"^
-X POST ^
-H "Content-Type: application/json"^
-H "Accept: application/json"^
-H "Authorization: Bearer %JWT_TOKEN%"^
-d "{\"FileInfo\":{\"FilePath\":\"signaturedocs/signedCollectionsOne_page.docx\"},\"Options\":[{\"AllPages\":true,\"SignatureType\":\"Barcode\"},{\"AllPages\":true,\"SignatureType\":\"QRCode\"}]}"
The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.
// For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-dotnet-samplesstringMyClientSecret="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudstringMyClientId="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudvarconfiguration=newConfiguration(MyClientId,MyClientSecret);varapiInstance=newSignApi(configuration);// Barcode Search options.varbarcodeOptions=newSearchBarcodeOptions{SignatureType=SignatureTypeEnum.Barcode,MatchType=SearchBarcodeOptions.MatchTypeEnum.Contains,Text="123456789012",BarcodeType="Code128",AllPages=false,Page=1,PagesSetup=newPagesSetup{EvenPages=false,FirstPage=true,LastPage=false,OddPages=false,PageNumbers=newList<int?>{1}}};// QRCode search options.varqrCodeOptions=newSearchQRCodeOptions{SignatureType=SignatureTypeEnum.QRCode,MatchType=SearchQRCodeOptions.MatchTypeEnum.Contains,Text="GroupDocs.Signature Cloud",QRCodeType="Aztec",AllPages=false,Page=1,PagesSetup=newPagesSetup{EvenPages=false,FirstPage=true,LastPage=false,OddPages=false,PageNumbers=newList<int?>{1}}};// Search settings.varsearchSettings=newSearchSettings{FileInfo=newFileInfo{FilePath="signedCollection_one-page.docx"},Options=newList<SearchOptions>{barcodeOptions,qrCodeOptions}};// Create request.varrequest=newSearchSignaturesRequest(searchSettings);// Call api method with request.varresponse=apiInstance.SearchSignatures(request);
// For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-java-samples
StringMyClientSecret="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
StringMyClientId="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
Configurationconfiguration=newConfiguration(MyClientId,MyClientSecret);SignApiapiInstance=newSignApi(configuration);FileInfofileInfo=newFileInfo();fileInfo.setFilePath("Signaturedocs\\signedCollectionOne_page.docx");InfoSettingsinfoSettings=newInfoSettings();infoSettings.setFileInfo(fileInfo);SearchBarcodeOptionsbarcodeOptions=newSearchBarcodeOptions();barcodeOptions.setSignatureType(SignatureTypeEnum.BARCODE);barcodeOptions.setPage(1);barcodeOptions.setAllPages(true);PagesSetuppagesSetup=newPagesSetup();pagesSetup.setEvenPages(false);pagesSetup.setFirstPage(true);pagesSetup.setLastPage(false);pagesSetup.setOddPages(false);pagesSetup.addPageNumbersItem(1);barcodeOptions.setPagesSetup(pagesSetup);barcodeOptions.setBarcodeType("Code128");barcodeOptions.setText("123456789012");barcodeOptions.setMatchType(MatchTypeEnum.CONTAINS);SearchDigitalOptionsdigitalOptions=newSearchDigitalOptions();digitalOptions.setSignatureType(SignatureTypeEnum.DIGITAL);digitalOptions.setPage(1);digitalOptions.setAllPages(true);pagesSetup=newPagesSetup();pagesSetup.setEvenPages(false);pagesSetup.setFirstPage(true);pagesSetup.setLastPage(false);pagesSetup.setOddPages(false);pagesSetup.addPageNumbersItem(1);digitalOptions.setPagesSetup(pagesSetup);SearchSettingssearchSettings=newSearchSettings();searchSettings.addOptionsItem(barcodeOptions);searchSettings.addOptionsItem(digitalOptions);searchSettings.setFileInfo(fileInfo);SearchSignaturesRequestrequest=newSearchSignaturesRequest(searchSettings);SearchResultresponse=apiInstance.searchSignatures(request);
// For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-php-samples
useGroupDocs\Signature\Model;useGroupDocs\Signature\Model\Requests;$ClientId="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
$ClientSecret="";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
$configuration=newGroupDocs\Signature\Configuration();$configuration->setAppSid($ClientId);$configuration->setAppKey($ClientSecret);$apiInstance=newGroupDocs\Signature\SignApi($configuration);$fileInfo=newGroupDocs\Signature\Model\FileInfo();$fileInfo->setFilePath("signaturedocs/signedCollectionsOne_page.docx");$fileInfo->setPassword("");$settings=newGroupDocs\Signature\Model\SearchSettings();$settings->setFileInfo($fileInfo);// Search QrCode options
$QrCodeoptions=newGroupDocs\Signature\Model\SearchQRCodeOptions();$QrCodeoptions->setPage(1);$QrCodeoptions->setAllPages(false);$QrCodeoptions->setSignatureType(GroupDocs\Signature\Model\OptionsBase::SIGNATURE_TYPE_QR_CODE);$QrCodeoptions->setQRCodeType("Aztec");// Search Barcode options
$barcodeOptions=newGroupDocs\Signature\Model\SearchBarcodeOptions();$barcodeOptions->setPage(1);$barcodeOptions->setAllPages(false);$barcodeOptions->setSignatureType(GroupDocs\Signature\Model\OptionsBase::SIGNATURE_TYPE_BARCODE);$barcodeOptions->setBarcodeType("Code128");$barcodeOptions->setText("123456789012");$settings->setOptions([$QrCodeoptions,$barcodeOptions]);$request=newGroupDocs\Signature\Model\Requests\SearchSignaturesRequest($settings);$response=$apiInstance->searchSignatures($request);
// For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-node-samples
global.signature_cloud=require("groupdocs-signature-cloud");global.clientId="XXXX-XXXX-XXXX-XXXX";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
global.clientSecret="XXXXXXXXXXXXXXXX";// Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud
global.signApi=signature_cloud.SignApi.fromKeys(clientId,clientSecret);letfileInfo=newsignature_cloud.FileInfo();fileInfo.filePath="signaturedocs/signedCollection_One_page.docx";letBarcodeOpts=newsignature_cloud.SearchBarcodeOptions();BarcodeOpts.signatureType=signature_cloud.OptionsBase.SignatureTypeEnum.Barcode;BarcodeOpts.matchType=signature_cloud.SearchQRCodeOptions.MatchTypeEnum.Contains;BarcodeOpts.allPages=true;letDigitalopts=newsignature_cloud.SearchDigitalOptions();Digitalopts.signatureType=signature_cloud.OptionsBase.SignatureTypeEnum.Digital;letsettings=newsignature_cloud.SearchSettings();settings.fileInfo=fileInfo;settings.options=[BarcodeOpts,Digitalopts];letrequest=newsignature_cloud.SearchSignaturesRequest(settings);letresponse=awaitsignApi.searchSignatures(request);
# For complete examples and data files, please go to https://github.com/groupdocs-signature_cloud-cloud/groupdocs-signature_cloud-cloud-python-samplesfromgroupdocs_signature_cloudimport*importgroupdocs_signature_cloudclient_id="XXXX-XXXX-XXXX-XXXX"# Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudclient_secret="XXXXXXXXXXXXXXXX"# Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudapi=groupdocs_signature_cloud.SignApi.from_keys(client_id,client_secret)fileInfo=FileInfo()fileInfo.file_path="signaturedocs\\signedCollectionOne_page.docx"Digitalopts=SearchDigitalOptions()Digitalopts.signature_type='Digital'Barcodeopts=SearchBarcodeOptions()Barcodeopts.page=1Barcodeopts.signature_type='Barcode'settings=SearchSettings()settings.options=[Digitalopts,Barcodeopts]settings.file_info=fileInforequest=SearchSignaturesRequest(settings)response=api.search_signatures(request)
# For complete examples and data files, please go to https://github.com/groupdocs-signature-cloud/groupdocs-signature-cloud-ruby-samplesrequire'groupdocs_signature_cloud'$client_id="XXXX-XXXX-XXXX-XXXX"# Get ClientId and ClientSecret from https://dashboard.groupdocs.cloud$client_secret="XXXXXXXXXXXXXXXX"# Get ClientId and ClientSecret from https://dashboard.groupdocs.cloudapi=GroupDocsSignatureCloud::SignApi.from_keys($client_id,$client_secret)$info=GroupDocsSignatureCloud::FileInfo.new()$info.file_path="signaturedocs\\signedCollectionOne_page.docx"$BarcodeOpts=GroupDocsSignatureCloud::SearchBarcodeOptions.new()$BarcodeOpts.signature_type="Barcode"$BarcodeOpts.all_pages=true$BarcodeOpts=GroupDocsSignatureCloud::SearchQRCodeOptions.new()$BarcodeOpts.signature_type="QRCode"$BarcodeOpts.all_pages=true$settings=GroupDocsSignatureCloud::SearchSettings.new()$settings.options=[$BarcodeOpts,$BarcodeOpts]$settings.file_info=$info$request=GroupDocsSignatureCloud::SearchSignaturesRequest.new($settings)# Executing an API.$response=api.search_signatures($request)
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
On this page
Analyzing your prompt, please hold on...
An error occurred while retrieving the results. Please refresh the page and try again.