← FlexAPI Documentation / Reference / Account Creation API

Account Creation API

The Account Creation API lets an integrated sponsor, such as a SIGNiX software partner, create subordinate client accounts within that sponsor. Each account has its own credentials, workgroups and users. You can also configure feature sets such as notary and API or MyDoX access.

SIGNiX approval required

Using the Account Creation API must be discussed with, and approved by, SIGNiX. It has significant implications for contractual obligations and involves billing and other requirements. There will be additional steps to complete before you can create accounts in Production. Contact SIGNiX to get started.

Before you call

  • It uses OAuth 2.0 only. Unlike the rest of the FlexAPI, it does not use the Sponsor, Client, UserId and Pswd credentials. SIGNiX must configure your account to allow OAuth authentication. See Authenticating to SIGNiX via OAuth.
  • It has its own endpoints. They are different from the standard FlexAPI endpoints. See the table below.
  • Use the admin:account scope. A token is good for 30 minutes.
  • Validate before you create. Validating the details first avoids unexpected errors and duplicate accounts.

Endpoints

Send all calls to the Account Creation API to these endpoints. They are different from the standard FlexAPI endpoints.

CallWebtestProduction
Tokenhttps://webtest.signix.biz/restservices/oauth2/tokenhttps://www.signix.net/restservices/oauth2/token
Account validationhttps://webtest.signix.biz/restservices/shoppingcart/accounts/validatehttps://www.signix.net/restservices/shoppingcart/accounts/validate
Account creationhttps://webtest.signix.biz/restservices/shoppingcart/accountshttps://www.signix.net/restservices/shoppingcart/accounts

Flow

  1. Generate an OAuth token with the appropriate scope.
  2. Validate the details of the account you want to create, to avoid unexpected errors and duplication.
  3. Generate the account.

Generate an OAuth token

Send these key-value pairs to the Token endpoint above. The token you get back is good for 30 minutes. For more on OAuth with SIGNiX, see Authenticating to SIGNiX via OAuth.

KeyValue
grant_typeclient_credentials
client_idYour sponsor ID.
client_secretYour SIGNiX API password.
scopeadmin:account

If the information is correct, you receive a response like the one below. Store the token for the next steps.

Token response
// Response body (JSON)
{
  "access_token": "YOUR_ACCESS_TOKEN",
  "token_type": "bearer",
  "expires_in": "1800", // seconds: 30 minutes
  "scope": "admin:account"
}

Validate new account details

This step is critical to avoid mistakes. Pass the access token from the previous step as a bearer token in the Authorization header, Authorization: Bearer YOUR_ACCESS_TOKEN. Then send the JSON below to the account validation endpoint, customized as described in the field reference that follows. The values shown are placeholders.

Account validation request
// Request body (JSON), sent to the account validation endpoint
{
  "autogenerateCompanyID": "no",
  "defaultCompanyID": "YOUR_COMPANY_ID",
  "includeSignixUserIDs": "yes",
  "accountData": {
    "companyID": "YOUR_COMPANY_ID",
    "standaloneAccount": "no",
    "accountType": "mydox",
    "productType": "ron",
    "sponsorID": "YOUR_SPONSOR_ID",
    "companyName": "YOUR_COMPANY_NAME",
    "billingContactFirstName": "YOUR_BILLING_FIRST_NAME",
    "billingContactLastName": "YOUR_BILLING_LAST_NAME",
    "billingContactEmail": "YOUR_BILLING_EMAIL",
    "billingContactPhoneNumber": "YOUR_BILLING_PHONE",
    "billingContactAddress1": "YOUR_BILLING_ADDRESS_1",
    "billingContactAddress2": "",
    "billingContactCity": "YOUR_BILLING_CITY",
    "billingContactState": "YOUR_BILLING_STATE",
    "billingContactZipCode": "YOUR_BILLING_ZIP",
    "hubspotAccountID": "",
    "password": "YOUR_API_PASSWORD"
  },
  "workgroupData": [
    {
      "refID": "1",
      "name": "YOUR_WORKGROUP",
      "onlyViewMyDocumentSets": true,
      "onlyViewMyTemplates": true,
      "userData": []
    }
  ],
  "userData": [
    {
      "firstName": "YOUR_FIRST_NAME_1",
      "lastName": "YOUR_LAST_NAME_1",
      "email": "YOUR_EMAIL_1",
      "userID": "",
      "assignedWorkgroups": "Corporate Administrator"
    },
    {
      "firstName": "YOUR_FIRST_NAME_2",
      "lastName": "YOUR_LAST_NAME_2",
      "email": "YOUR_EMAIL_2",
      "userID": "",
      "assignedWorkgroups": "YOUR_WORKGROUP"
    }
  ],
  "notaryData": {
    "floridaNotary": "yes",
    "checkUsersInMeeting": "no",
    "allowPrintSaveButtons": "yes"
  }
}

Field reference

Request level

KeyValue
autogenerateCompanyIDSet to no to specify the client ID yourself. If set to yes, leave companyID blank.
defaultCompanyIDMust be the same as companyID.
includeSignixUserIDsMandatory. Must be yes.

accountData

KeyValue
companyIDThe identifier you want for the new account. It is used to create the Client identifier, which you then use as the Client in CustInfo on the standard API calls.
standaloneAccountMandatory. Must be no.
accountTypeOne of mydox, api or both, depending on what the integrating sponsor needs.
productTypedigsig, unless notary will be involved. Then use ron.
sponsorIDThe sponsor ID of the integrating SIGNiX partner.
companyNameThe human-readable name of the account, displayed in the user interface and other output users can see. It is not the identifier used in API calls. That is the companyID.
billingContactFirstName, billingContactLastName, billingContactEmail, billingContactPhoneNumberThe billing contact. You can customize it to the client's requirements or point it at the sponsor's billing contact.
billingContactAddress1, billingContactAddress2, billingContactCity, billingContactState, billingContactZipCodeThe billing contact's address. billingContactAddress2 is for any additional address line.
hubspotAccountIDEnter it only if SIGNiX provides one. Otherwise leave it blank.
passwordThe client's API password, required if the client needs API access. It must meet typical strong-password rules.

workgroupData

An array with one entry for each workgroup.

KeyValue
refIDA reference number, unique for each workgroup within this request. Sequential numbers such as 1, 2, 3 work.
nameThe name of the workgroup that users can be given access to.
onlyViewMyDocumentSetsA permission for this workgroup: whether users can see only their own transactions. yes or no. true and false are also accepted.
onlyViewMyTemplatesA permission for this workgroup: whether users can see only their own templates. yes or no. true and false are also accepted.
userDataUsers can be added here, but they can also be added in the top-level userData below.

userData

An array with one entry for each user who will have access to the account.

KeyValue
firstName, lastName, emailThe user's name and email address.
userIDThe user's SIGNiX UserID. Leave it blank unless the user has already been created and you know the UserID.
assignedWorkgroupsThe workgroups the user has access to, by the name in workgroupData. Separate several with commas. Corporate Administrator is a built-in workgroup.

notaryData

Customizations for notary accounts. If productType is digsig, leave these as null.

KeyValue
floridaNotaryyes if the notaries are from Florida. Otherwise no.
checkUsersInMeetingGenerally no. Ask SIGNiX if you have questions.
allowPrintSaveButtonsyes to give signers the Print and Save buttons during signing.

If everything is correct, the system returns HTTP 200 OK. Otherwise it returns an error response with a likely reason for the failure.

Generate the account

Pass the access token as a bearer token in the Authorization header again, and send the same JSON to the account creation endpoint. If everything is correct, the system returns HTTP 201. Otherwise it returns an error response with a likely reason for the failure.

Once the account exists, the companyID you sent is used to create the Client identifier. Use it as the Client in CustInfo on the standard API calls, such as SubmitDocument. The companyName is only the human-readable name that people see.