Fair API Pricing

    No Surprise Fees

    Secure Your Document Distribution and Management with a Signority API Plan

    Home
    Home
    Quick Navigation
    Getting Started
    Getting Started
    Quick Start
    Testing
    Authentication
    Charging and Rate Limits
    API Reference
    API Reference
    Callbacks
    Constants
    Examples
    Examples
    Integration Examples
    Sample Code
    Anchor Tags
    Use Cases
    Use Cases
    Frequently Asked Questions
    Frequently Asked Questions
    Further Support

    Retrieve Account Details

    GET: /v1/user/

    Description
    Gets the currently logged in user’s details

     

    Format
    JSON <multipart/related>

     

    URL Parameters
    None

     

    Data Parameters
    None

     

     Response
    Response returns a response containing the logged in user’s account details or an error due to invalid authentication

     

    Response Parameters

    Field Mandatory Type Description
    success Yes Boolean True if the request was successful, False otherwise
    user Yes JSONObject Object containing the user’s information
    email Yes  String The user’s email
    id Yes  Integer The user’s unique id
    phonenumber Yes  String The user’s phone number
    userProduct Yes  JSONObject  Information about the user’s plan
    userSetting Yes  JSONObject The user’s settings

    EXAMPLE REQUEST / RESPONSE (Python)
    Request:
requests.get("https://sign.signority.com/api/v1/user/", auth=(APIKey, ""))
Response:
{
    'success': True,
    'user':
        {
            'bms': 449,
            'companyname': 'Signority',
            'country': 'CA',
            'credit': 0,
            'currency':
                {
                    'code': 'CAD',
                    'id': 2,
                    'prefix': '$',
                    'suffix': 'CAD'
                },
            'datecreated':
                {
                    'date': 21,
                    'day': 4,
                    'hours': 16,
                    'minutes': 18,
                    'month': 4,
                    'nanos': 0,
                    'seconds': 47,
                    'time': 1590092327000,
                    'timezoneOffset': 240,
                    'year': 120
                },
            'email': 'signorityapidemo@gmail.com',
            'firstname': 'Demo',
            'id': 1354,
            'lastname': 'Account',
            'phonenumber': '1234567890',
            'state': 'Ontario',
            'status': 'Active',
            'userProduct':
                {
                    'amount': 0,
                    'apiKeyEnabled': True,
                    'begindate': '2020-05-04',
                    'billingcycle': 'Annually',
                    'currency':
                        {
                            'code': 'CAD',
                            'id': 2,
                            'prefix': '$',
                            'suffix': 'CAD'
                        },
                    'deductionamount': 2160,
                    'id': 1166,
                    'name': 'Plus Plan',
                    'nextduedate': '2020-06-04',
                    'product': 10601,
                    'status': 'Active',
                    'stripeStatus': 'trialing',
                    'stripeTrialEnd': 1591221600,
                    'stripeTrialStart': 1590012000},
            'userSetting':
                {
                    'APIKey': '56c8beb5-fef1-4269-b5c1-bc3cd302750b',
                    'AttachDocCertificateToTheFinalEmailAttachment': True,
                    'CombineFinalEmailAttachmentsIntoOnePDFFile': True,
                    'ContactsSharingEnabled': False,
                    'DSignEnabled': True,
                    'DefaultExpireDaysAfterSent': 180,
                    'DefaultLastReminderDaysBeforeExpire': 3,
                    'DefaultMaxReminderEmailCount': 5,
                    'DefaultReminderEmailIntervalDays': 3,
                    'DocSharingEnabled': False,
                    'ESignEnabled': True,
                    'ESignPoweredByEnabled': False,
                    'EmailAddressConfirmed': True,
                    'GUID': '79d0c6b8-3eee-4813-bab2-20c5c44e92b5',
                    'HelpInstructionEnabled': True,
                    'LanguageLocalization': 550,
                    'NotificationExpiredDocEmailEnabled': True,
                    'NotificationFinalEmailWithAttachmentEmailEnabled': True,
                    'NotificationFinalEmailWithAttachmentToAllRecipientsEnabled': True,
                    'NotificationFinalEmailWithPDFDownloadLinkToAllRecipientsEnabled': False,
                    'NotificationFinalEmailWithPDFDownloadLinkToSenderEnabled': False,
                    'NotificationNoFinalEmailToRecpientsEnabled': False,
                    'NotificationNoFinalEmailToSenderEnabled': False,
                    'NotificationRecipientSignDocEmailEnabled': True,
                    'NotificationRecipientViewDocEmailEnabled': False,
                    'NotificationReminderEmailEnabled': True,
                    'PkiEnabled': False,
                    'ShareAddressBookToTeam': False,
                    'ShareAutomaticallyDocToTeam': False,
                    'ShareAutomaticallyTemplateToTeam': False,
                    'authKey': 'Basic NTZjOGJlYjUtZmVmMS00MjY5LWI1YzEtYmMzY2QzMDI3NTBiOg==',
                    'hideButtonChangeSigner': False,
                    'hideButtonDownload': False,
                    'hideButtonHelp': False,
                    'hideButtonReject': False,
                    'hideButtonSave': False,
                    'hideButtonStatus': False,
                    'hideButtonThumbnail': False,
                    'hideSigningButtonDrawingSignature': False,
                    'hideSigningButtonTypeSignature': False,
                    'hideSigningButtonUploadSignature': False,
                    'id': 1352
                }
        }
}