← FlexAPI Documentation / Reference / 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.
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.
admin:account scope. A token is good for 30 minutes.Send all calls to the Account Creation API to these endpoints. They are different from the standard FlexAPI endpoints.
| Call | Webtest | Production |
|---|---|---|
| Token | https://webtest.signix.biz/restservices/oauth2/token | https://www.signix.net/restservices/oauth2/token |
| Account validation | https://webtest.signix.biz/restservices/shoppingcart/accounts/validate | https://www.signix.net/restservices/shoppingcart/accounts/validate |
| Account creation | https://webtest.signix.biz/restservices/shoppingcart/accounts | https://www.signix.net/restservices/shoppingcart/accounts |
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.
| Key | Value |
|---|---|
grant_type | client_credentials |
client_id | Your sponsor ID. |
client_secret | Your SIGNiX API password. |
scope | admin:account |
If the information is correct, you receive a response like the one below. Store the token for the next steps.
// Response body (JSON)
{
"access_token": "YOUR_ACCESS_TOKEN",
"token_type": "bearer",
"expires_in": "1800", // seconds: 30 minutes
"scope": "admin:account"
}
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.
// 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"
}
}
| Key | Value |
|---|---|
autogenerateCompanyID | Set to no to specify the client ID yourself. If set to yes, leave companyID blank. |
defaultCompanyID | Must be the same as companyID. |
includeSignixUserIDs | Mandatory. Must be yes. |
| Key | Value |
|---|---|
companyID | The 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. |
standaloneAccount | Mandatory. Must be no. |
accountType | One of mydox, api or both, depending on what the integrating sponsor needs. |
productType | digsig, unless notary will be involved. Then use ron. |
sponsorID | The sponsor ID of the integrating SIGNiX partner. |
companyName | The 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, billingContactPhoneNumber | The billing contact. You can customize it to the client's requirements or point it at the sponsor's billing contact. |
billingContactAddress1, billingContactAddress2, billingContactCity, billingContactState, billingContactZipCode | The billing contact's address. billingContactAddress2 is for any additional address line. |
hubspotAccountID | Enter it only if SIGNiX provides one. Otherwise leave it blank. |
password | The client's API password, required if the client needs API access. It must meet typical strong-password rules. |
An array with one entry for each workgroup.
| Key | Value |
|---|---|
refID | A reference number, unique for each workgroup within this request. Sequential numbers such as 1, 2, 3 work. |
name | The name of the workgroup that users can be given access to. |
onlyViewMyDocumentSets | A permission for this workgroup: whether users can see only their own transactions. yes or no. true and false are also accepted. |
onlyViewMyTemplates | A permission for this workgroup: whether users can see only their own templates. yes or no. true and false are also accepted. |
userData | Users can be added here, but they can also be added in the top-level userData below. |
An array with one entry for each user who will have access to the account.
| Key | Value |
|---|---|
firstName, lastName, email | The user's name and email address. |
userID | The user's SIGNiX UserID. Leave it blank unless the user has already been created and you know the UserID. |
assignedWorkgroups | The workgroups the user has access to, by the name in workgroupData. Separate several with commas. Corporate Administrator is a built-in workgroup. |
Customizations for notary accounts. If productType is digsig, leave these as null.
| Key | Value |
|---|---|
floridaNotary | yes if the notaries are from Florida. Otherwise no. |
checkUsersInMeeting | Generally no. Ask SIGNiX if you have questions. |
allowPrintSaveButtons | yes 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.
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.
1110 Market Street, Suite 402
Chattanooga, TN 37402
877.890.5350
info@SIGNiX.com
©2016 SIGNiX. All Rights Reserved.