Senders

This guide covers how to manage your senders in your OneSpan Sign account.

OneSpan Sign provides you with the ability to add senders to your account, allowing them to create and send document packages (transaction in the new UI) for signature. As an account owner, you will have access to the packages created by your senders. Though, you’ll only be able to retrieve the packages created by your senders through the SDKs/API. If you want to access from the UI the packages created by your senders, you will need your senders to delegate access to you. This is also the case for the reverse situation. For more information on delegating access, see this guide.

Senders in the UI

Before getting into the code, you should locate your senders section in your UI. After logging into your OneSpan Sign account, click on your name in your toolbar and select “Admin”. From the menu on the left-hand side, select “Senders”. After running your code, you should find your senders here.

Capture

The Code

To invite a user to be a sender in your account, you will need to build an AccountMember object. Then, you call on your OneSpan Sign AccountService to send the invitation. When a new sender is invited to join an account, they are by default added in an inactive state. The sender will receive an email containing a link that they will need to click to activate their account. You can skip the verification step by setting the status to ACTIVE when building your AccountMember object.

AccountMember member = AccountMemberBuilder.newAccountMember("john.smith@example.com ")
				.withFirstName("John")
				.withLastName("Smith")
				.withCompany("ABC Bank")
				.withTitle("CEO")
				.withStatus(SenderStatus.ACTIVE)
				.build();
		
client.getAccountService().inviteUser(member);

When a sender is invited to join an account, they are sent an email which they must use to activate their membership. The following code snippet illustrates how to re-send that email.

eslClient.getAccountService().sendInvite(retrievedSender.getId());

You can also retrieve your senders by calling on your OneSpan Sign AccountService. Below is a sample code on how to retrieve all your senders, which comes as a page from OneSpan Sign, along with their emails and ids. The sender’s ID is required in order to update or delete a sender. In the code below, the number of senders returned in the PageRequest is set to 5. The maximum number of senders that you can retrieve per page is 50. The first value in the PageRequest (variable ‘i’) is the starting point in the overall list of senders that should be returned. This variable is incremented as you step through your senders to keep track of where we are in the overall list of senders.

int i = 1;
Map<String, Sender> accountMembers = client.getAccountService().getSenders(Direction.ASCENDING, new PageRequest(i,5));
		
while (!accountMembers.isEmpty()) {
for (Map.Entry<String, Sender> entry : accountMembers.entrySet())
	{
		System.out.println(entry.getKey() + " / " + entry.getValue().getId());
		i++;
	}
accountMembers = client.getAccountService().getSenders(Direction.ASCENDING, new PageRequest(i,5));
}

As mentioned above, you will need the sender ID to update your sender. Note that the email address cannot be updated once you’ve created your sender. You will need to create a new sender, in this case.

SenderInfo updatedSenderInfo = SenderInfoBuilder.newSenderInfo("john.smith@example.com")
                .withName( "John", "Smith" )
                .withTitle( "CEO" )
                .withCompany("XYZ Bank")
                .build();
 
client.getAccountService().updateSender(updatedSenderInfo, "{senderId}");

Similarly, you will also need the sender ID to delete your sender. If your sender has packages in their inbox or in draft status, the sender will be locked instead of being deleted, and will not be able to create or send packages anymore.

client.getAccountService().deleteSender("{senderId}");

You can also retrieve a particular sender in an account.

Sender retrievedSender = eslClient.getAccountService().getSender("senderId");

Finally, the sample code below shows you how to build a document package to be sent by a particular sender from your account:

DocumentPackage packageToSend = PackageBuilder.newPackageNamed("Cleaning Contract Example")
			.withSenderInfo(SenderInfoBuilder.newSenderInfo("john.smith@example.com"))
			.withSigner(SignerBuilder.newSignerWithEmail("mary.doe@example.com")
					.withFirstName("Mary")
					.withLastName("Doe")
					.withCustomId("client"))
			.withSigner(SignerBuilder.newSignerWithEmail("john.smith@example.com")
					.withFirstName("John")
					.withLastName("Smith")
					.withCustomId("contractor"))
			.withDocument(DocumentBuilder.newDocumentWithName("Contract.pdf")
					.fromStream(new FileInputStream("DOC_FILE_PATH"), DocumentType.PDF)
					.enableExtraction())
				.build();

Running Your Code

You should be able to see your newly created sender(s) in your OneSpan Sign account, as mentioned in the “Senders in the UI” segment.

Included in this guide is the code that prints out the sender emails and ids. Below is a screenshot of what the output looks like.

Capture

Get the Code

OneSpan Sign provides you with the ability to add senders to your account, allowing them to create and send document packages (transaction in the new UI) for signature. As an account owner, you will have access to the packages created by your senders. Though, you’ll only be able to retrieve the packages created by your senders through the SDKs/API. If you want to access from the UI the packages created by your senders, you will need your senders to delegate access to you. This is also the case for the reverse situation. For more information on delegating access, see this guide.

Senders in the UI

Before getting into the code, you should locate your senders section in your UI. After logging into your OneSpan Sign account, click on your name in your toolbar and select “Admin”. From the menu on the left-hand side, select “Senders”. After running your code, you should find your senders here.

Capture

The Code

To invite a user to be a sender in your account, you will need to build an AccountMember object. Then, you call on your OneSpan Sign AccountService to send the invitation. When a new sender is invited to join an account, they are by default added in an inactive state. The sender will receive an email containing a link that they will need to click to activate their account. You can skip the verification step by setting the status to ACTIVE when building your AccountMember object.

AccountMember member = AccountMemberBuilder.NewAccountMember("john.smith@example.com")
				.WithFirstName("John")
				.WithLastName("Smith")
				.WithCompany("ABC Bank")
				.WithTitle("CEO")
				.WithStatus(SenderStatus.ACTIVE)
				.Build();
		
client.AccountService.InviteUser(member);

When a sender is invited to join an account, they are sent an email which they must use to activate their membership. The following code snippet illustrates how to re-send that email.

eslClient.AccountService.SendInvite(retrievedSender.Id);

You can also retrieve your senders by calling on your OneSpan Sign AccountService. Below is a sample code on how to retrieve all your senders, which comes as a page from OneSpan Sign, along with their emails and ids. The sender’s ID is required in order to update or delete a sender. In the code below, the number of senders returned in the PageRequest is set to 5. The maximum number of senders that you can retrieve per page is 50. The first value in the PageRequest (variable ‘i’) is the starting point in the overall list of senders that should be returned. This variable is incremented as you step through your senders to keep track of where we are in the overall list of senders.

int i = 1;
IDictionary<string, Sender> accountMembers = client.AccountService.GetSenders(Direction.ASCENDING, new PageRequest(i, 5));

while (accountMembers.Count != 0)
{
foreach (KeyValuePair<string, Sender> entry in accountMembers)
      	{
        		Debug.WriteLine(entry.Key + " / " + entry.Value.Id);
                i++;
       	}
      	accountMembers = client.AccountService.GetSenders(Direction.ASCENDING, new PageRequest(i, 5));
}

As mentioned above, you will need the sender ID to update your sender. Note that the email address cannot be updated once you’ve created your sender. You will need to create a new sender, in this case.

SenderInfo updatedSenderInfo = SenderInfoBuilder.NewSenderInfo("john.smith@example.com")
                .WithName( "John", "Smith" )
                .WithTitle( "CEO" )
                .WithCompany("XYZ Bank")
                .Build();
 
client.AccountService.UpdateSender(updatedSenderInfo, "{senderId}");

Similarly, you will also need the sender ID to delete your sender. If your sender has packages in their inbox or in draft status, the sender will be locked instead of being deleted, and will not be able to create or send packages anymore.

client.AccountService.DeleteSender("{senderId}");

You can also retrieve a particular sender in an account.

Sender retrievedSender = eslClient.AccountService.GetSender("senderId");

Finally, the sample code below shows you how to build a document package to be sent by a particular sender from your account:

DocumentPackage packageToSend = PackageBuilder.NewPackageNamed("Cleaning Contract Example")
                .WithSenderInfo(SenderInfoBuilder.NewSenderInfo("john.smith@example.com"))
                .WithSigner(SignerBuilder.NewSignerWithEmail("mary.doe@example.com ")
                        .WithFirstName("Mary")
                        .WithLastName("Doe")
                        .WithCustomId("client"))
                .WithSigner(SignerBuilder.NewSignerWithEmail("john.smith@example.com")
                        .WithFirstName("John")
                        .WithLastName("Smith")
                        .WithCustomId("contractor"))
                .WithDocument(DocumentBuilder.NewDocumentNamed("Contract.pdf")
                        .FromStream(new FileStream("DOC_FILE_PATH", FileMode.Open), DocumentType.PDF)
                        .EnableExtraction())
                .Build();

Running Your Code

You should be able to see your newly created sender(s) in your OneSpan Sign account, as mentioned in the “Senders in the UI” segment.

Included in this guide is the code that prints out the sender emails and ids. Below is a screenshot of what the output looks like.

Capture

Get the Code

OneSpan Sign provides you with the ability to add senders to your account, allowing them to create and send document packages (transaction in the new UI) for signature. As an account owner, you will have access to the packages created by your senders. Though, you’ll only be able to retrieve the packages created by your senders through the SDKs/API. If you want to access from the UI the packages created by your senders, you will need your senders to delegate access to you. This is also the case for the reverse situation. For more information on delegating access, see this guide.

Senders in the UI

Before getting into the code, you should locate your senders section in your UI. After logging into your OneSpan Sign account, click on your name in your toolbar and select “Admin”. From the menu on the left-hand side, select “Senders”. After running your code, you should find your senders here.

Capture

The Code

To invite a user to be a sender in your account, you will need to make the request below.

HTTP Request
POST /api/account/senders

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Request Payload

{
   "email" : "john.smith@example.com",
   "firstName" : "John",
   "lastName" : "Smith",
   "company" : "ABC Bank",
   "title" : "CEO",
   "status" : "ACTIVE"
}

For a complete description of each field, take a look at the JSON Properties section below.

Response Payload

{
    "status": "ACTIVE",
    "language": "en",
    "signature": null,
    "id": "gF0JJvbDb2Y0",
    "data": {
        "hasNotCreatedATransaction": true,
        "showIntro": true
    },
    "account": {
        "id": "3vD0Dc9Fh7wQ",
        "data": null,
        "updated": "2016-05-05T19:30:13Z",
        "company": {
            "id": "jVWmyg4cyis8",
            "data": null,
            "address": {
                "address1": null,
                "address2": null,
                "city": null,
                "country": null,
                "zipcode": null,
                "state": null
            },
            "name": "OneSpan Sign"
        },
        "licenses": [
            {
                "status": "ACTIVE",
                "paidUntil": "2020-05-05T00:00:00Z",
                "plan": {
                    "group": "",
                    "description": "E-Sign Hundreds of Documents with Unlimited Signers",
                    "id": "sandbox",
                    "features": null,
                    "price": {
                        "amount": 0,
                        "currency": {
                            "id": "USD",
                            "data": null,
                            "name": "US Dollar"
                        }
                    },
                    "original": null,
                    "cycle": "YEAR",
                    "contract": "YEAR",
                    "freeCycles": null,
                    "quotas": [
                        {
                            "cycle": null,
                            "scope": "ACCOUNT",
                            "limit": 100,
                            "target": "SENDER"
                        },
                        {
                            "cycle": null,
                            "scope": "SENDER",
                            "limit": 500,
                            "target": "DOCUMENT"
                        },
                        {
                            "cycle": null,
                            "scope": "SENDER",
                            "limit": 500,
                            "target": "STORAGE"
                        }
                    ],
                    "data": null,
                    "name": "Sandbox"
                },
                "transactions": [],
                "created": "2016-05-05T19:30:13Z"
            }
        ],
        "logoUrl": "",
        "providers": null,
        "customFields": [
            {
                "required": false,
                "id": "policy_number_id",
                "data": null,
                "translations": [
                    {
                        "description": "Car Insurance Policy Number.",
                        "language": "en",
                        "id": "",
                        "data": null,
                        "name": "Policy Number"
                    }
                ],
                "value": "123-456-789-0",
                "name": ""
            }
        ],
        "created": "2016-05-05T19:30:13Z",
        "owner": "ZQI8k6faVoM8",
        "name": "Haris Haidary"
    },
    "title": "CEO",
    "external": null,
    "updated": "2017-11-20T18:36:02Z",
    "memberships": [],
    "phone": "",
    "professionalIdentityFields": [],
    "userCustomFields": [],
    "locked": null,
    "activated": null,
    "company": "ABC Bank",
    "email": "john.smith@example.com",
    "firstName": "John",
    "lastName": "Smith",
    "type": "REGULAR",
    "name": "",
    "address": null,
    "created": "2017-11-20T18:36:02Z",
    "specialTypes": [],
    "hasDelegates": false
}

When a new sender is invited to join an account, they are by default added in an inactive state. The sender will receive an email containing a link that they will need to click to activate their account. You can skip the verification step by setting the status to ACTIVE when building your JSON.

When a sender is invited to join an account, they are sent an email which they must use to activate their membership. The following request illustrates how to re-send that email.

HTTP Request
POST /api/account/senders/{senderUid}/invite

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

You can also retrieve your senders:

HTTP Request
GET /api/account/senders?from=0&to=1

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Response Payload

{
    "results": [
        {
            "status": "ACTIVE",
            "language": "en",
            "signature": null,
            "id": "IBCyHvarzWsX",
            "data": {
                "hasNotCreatedATransaction": true,
                "showIntro": true
            },
            "account": {
                "id": "3vD0Dc9Fh7wQ",
                "created": "2016-05-05T19:30:13Z",
                "data": null,
                "company": {
                    "id": "jVWmyg4cyis8",
                    "data": null,
                    "address": {
                        "address1": null,
                        "address2": null,
                        "city": null,
                        "country": null,
                        "zipcode": null,
                        "state": null
                    },
                    "name": "OneSpan Sign"
                },
                "updated": "2016-05-05T19:30:13Z",
                "licenses": [
                    {
                        "status": "ACTIVE",
                        "transactions": [],
                        "created": "2016-05-05T19:30:13Z",
                        "paidUntil": "2020-05-05T00:00:00Z",
                        "plan": {
                            "group": "",
                            "description": "E-Sign Hundreds of Documents with Unlimited Signers",
                            "id": "sandbox",
                            "price": {
                                "amount": 0,
                                "currency": {
                                    "id": "USD",
                                    "data": null,
                                    "name": "US Dollar"
                                }
                            },
                            "original": null,
                            "features": null,
                            "data": null,
                            "cycle": "YEAR",
                            "contract": "YEAR",
                            "freeCycles": null,
                            "quotas": [
                                {
                                    "scope": "ACCOUNT",
                                    "cycle": null,
                                    "limit": 100,
                                    "target": "SENDER"
                                },
                                {
                                    "scope": "SENDER",
                                    "cycle": null,
                                    "limit": 500,
                                    "target": "DOCUMENT"
                                },
                                {
                                    "scope": "SENDER",
                                    "cycle": null,
                                    "limit": 500,
                                    "target": "STORAGE"
                                }
                            ],
                            "name": "Sandbox"
                        }
                    }
                ],
                "logoUrl": "",
                "providers": null,
                "customFields": [
                    {
                        "required": false,
                        "id": "policy_number_id",
                        "data": null,
                        "translations": [
                            {
                                "description": "Car Insurance Policy Number.",
                                "language": "en",
                                "id": "",
                                "data": null,
                                "name": "Policy Number"
                            }
                        ],
                        "value": "123-456-789-0",
                        "name": ""
                    }
                ],
                "owner": "ZQI8k6faVoM8",
                "name": "Haris Haidary"
            },
            "title": null,
            "activated": null,
            "company": "",
            "email": "mail73@mailinator.com",
            "firstName": "Peter",
            "lastName": "Pan",
            "external": null,
            "updated": "2017-11-13T15:07:49Z",
            "memberships": [],
            "phone": "",
            "professionalIdentityFields": [],
            "userCustomFields": [],
            "locked": null,
            "address": null,
            "created": "2017-11-13T15:07:49Z",
            "name": "",
            "type": "REGULAR",
            "specialTypes": [],
            "hasDelegates": false
        },
        {
            "status": "ACTIVE",
            "language": "en",
            "signature": null,
            "id": "2q37oSloj5AD",
            "data": {
                "hasNotCreatedATransaction": true,
                "showIntro": true
            },
            "account": {
                "id": "3vD0Dc9Fh7wQ",
                "created": "2016-05-05T19:30:13Z",
                "data": null,
                "company": {
                    "id": "jVWmyg4cyis8",
                    "data": null,
                    "address": {
                        "address1": null,
                        "address2": null,
                        "city": null,
                        "country": null,
                        "zipcode": null,
                        "state": null
                    },
                    "name": "OneSpan Sign"
                },
                "updated": "2016-05-05T19:30:13Z",
                "licenses": [
                    {
                        "status": "ACTIVE",
                        "transactions": [],
                        "created": "2016-05-05T19:30:13Z",
                        "paidUntil": "2020-05-05T00:00:00Z",
                        "plan": {
                            "group": "",
                            "description": "E-Sign Hundreds of Documents with Unlimited Signers",
                            "id": "sandbox",
                            "price": {
                                "amount": 0,
                                "currency": {
                                    "id": "USD",
                                    "data": null,
                                    "name": "US Dollar"
                                }
                            },
                            "original": null,
                            "features": null,
                            "data": null,
                            "cycle": "YEAR",
                            "contract": "YEAR",
                            "freeCycles": null,
                            "quotas": [
                                {
                                    "scope": "ACCOUNT",
                                    "cycle": null,
                                    "limit": 100,
                                    "target": "SENDER"
                                },
                                {
                                    "scope": "SENDER",
                                    "cycle": null,
                                    "limit": 500,
                                    "target": "DOCUMENT"
                                },
                                {
                                    "scope": "SENDER",
                                    "cycle": null,
                                    "limit": 500,
                                    "target": "STORAGE"
                                }
                            ],
                            "name": "Sandbox"
                        }
                    }
                ],
                "logoUrl": "",
                "providers": null,
                "customFields": [
                    {
                        "required": false,
                        "id": "policy_number_id",
                        "data": null,
                        "translations": [
                            {
                                "description": "Car Insurance Policy Number.",
                                "language": "en",
                                "id": "",
                                "data": null,
                                "name": "Policy Number"
                            }
                        ],
                        "value": "123-456-789-0",
                        "name": ""
                    }
                ],
                "owner": "ZQI8k6faVoM8",
                "name": "Haris Haidary"
            },
            "title": null,
            "activated": null,
            "company": "",
            "email": "mail72@mailinator.com",
            "firstName": "Mike",
            "lastName": "Smith",
            "external": null,
            "updated": "2017-11-13T15:07:49Z",
            "memberships": [],
            "phone": "",
            "professionalIdentityFields": [],
            "userCustomFields": [],
            "locked": null,
            "address": null,
            "created": "2017-11-13T15:07:50Z",
            "name": "",
            "type": "REGULAR",
            "specialTypes": [],
            "hasDelegates": false
        }
    ],
    "count": 8
}

You can customize the query parameters to your liking. For more information on the available query parameters, head over to OneSpan Sign’s documentation.

To update your sender, you will need your sender ID, which you can retrieve from the request above. Note that the email address cannot be updated once you’ve created your sender. You will need to create a new sender in this case.

To update your sender:

HTTP Request
POST /api/account/senders/{senderId}

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

{
    "firstName" : "John",
    "lastName" : "Smith",
    "company" : "XYZ Bank",
    "title" : "CEO",
}

Similarly, you will also need the sender ID to delete your sender. If your sender has packages in their inbox or in draft status, the sender will be locked instead of being deleted, and will not be able to create or send packages.

HTTP Request
DELETE /api/account/senders/{senderId}

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

You can also retrieve information about a particular sender:

HTTP Request
GET /api/account/senders/{senderId}

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Response Payload

{
    "status": "ACTIVE",
    "language": "en",
    "signature": null,
    "id": "IBCyHvarzWsX",
    "data": {
        "hasNotCreatedATransaction": true,
        "showIntro": true
    },
    "account": {
        "id": "3vD0Dc9Fh7wQ",
        "data": null,
        "updated": "2016-05-05T19:30:13Z",
        "company": {
            "id": "jVWmyg4cyis8",
            "data": null,
            "address": {
                "address1": null,
                "address2": null,
                "city": null,
                "country": null,
                "zipcode": null,
                "state": null
            },
            "name": "OneSpan Sign"
        },
        "licenses": [
            {
                "status": "ACTIVE",
                "paidUntil": "2020-05-05T00:00:00Z",
                "plan": {
                    "group": "",
                    "description": "E-Sign Hundreds of Documents with Unlimited Signers",
                    "id": "sandbox",
                    "features": null,
                    "price": {
                        "amount": 0,
                        "currency": {
                            "id": "USD",
                            "data": null,
                            "name": "US Dollar"
                        }
                    },
                    "original": null,
                    "cycle": "YEAR",
                    "contract": "YEAR",
                    "freeCycles": null,
                    "quotas": [
                        {
                            "cycle": null,
                            "scope": "ACCOUNT",
                            "limit": 100,
                            "target": "SENDER"
                        },
                        {
                            "cycle": null,
                            "scope": "SENDER",
                            "limit": 500,
                            "target": "DOCUMENT"
                        },
                        {
                            "cycle": null,
                            "scope": "SENDER",
                            "limit": 500,
                            "target": "STORAGE"
                        }
                    ],
                    "data": null,
                    "name": "Sandbox"
                },
                "transactions": [],
                "created": "2016-05-05T19:30:13Z"
            }
        ],
        "logoUrl": "",
        "providers": null,
        "customFields": [
            {
                "required": false,
                "id": "policy_number_id",
                "data": null,
                "translations": [
                    {
                        "description": "Car Insurance Policy Number.",
                        "language": "en",
                        "id": "",
                        "data": null,
                        "name": "Policy Number"
                    }
                ],
                "value": "123-456-789-0",
                "name": ""
            }
        ],
        "created": "2016-05-05T19:30:13Z",
        "owner": "ZQI8k6faVoM8",
        "name": "Haris Haidary"
    },
    "title": "CEO",
    "external": null,
    "updated": "2017-11-13T15:07:49Z",
    "memberships": [],
    "phone": "",
    "professionalIdentityFields": [],
    "userCustomFields": [],
    "locked": null,
    "activated": null,
    "company": "ABC Bank",
    "email": "mail73@mailinator.com",
    "firstName": "John",
    "lastName": "Smith",
    "type": "REGULAR",
    "name": "",
    "address": null,
    "created": "2017-11-13T15:07:49Z",
    "specialTypes": [],
    "hasDelegates": false
}

Finally, here is a sample request on how you would build a document package to be sent by a particular sender from your account:

HTTP Request
POST /api/packages

HTTP Headers
Accept: application/json
Content-Type: multipart/form-data
Authorization: Basic api_key

Request Payload

------WebKitFormBoundary1bNO60n7FqP5WO4t
Content-Disposition: form-data; name="file"; filename="testDocumentExtraction.pdf"
Content-Type: application/pdf

%PDF-1.5
%µµµµ
1 0 obj
<>>>
endobj.... 

------WebKitFormBoundary1bNO60n7FqP5WO4t
Content-Disposition: form-data; name="payload"

{
  "sender": {
    "email": "john.smith@example.com"
  },
  "documents": [
    {
      "extract": true,
      "name": "Contract"
    }
  ],
  "status": "DRAFT",
  "roles": [
    {
      "id": "contractor",
      "type": "SENDER",
      "signers": [
        {
          "email": "john.smith@example.com",
          "firstName": "John",
          "lastName": "Smith",
          "id": "contractor"
        }
      ],
      "name": "contractor"
    },
    {
      "id": "client",
      "type": "SIGNER",
      "signers": [
        {
          "email": "mary.doe@example.com",
          "firstName": "Mary",
          "lastName": "Doe",
          "id": "client"
        }
      ],
      "name": "client"
    }
  ],
  "type": "PACKAGE",
  "name": "Cleaning Contract Example"
}

------WebKitFormBoundary1bNO60n7FqP5WO4t--

For a complete description of each field, take a look at the JSON Properties section below.

Response Payload

{
    "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="
}

Running Your Code

After running your code, you should be able to see your newly created sender(s) in your OneSpan Sign account, as mentioned in the “Senders in the UI” segment.

capture

Get the Code

JSON Properties

Property Type Editable Required Default Sample Value(s)
status string Yes No INVITED ACTIVE / INVITED / LOCKED
email string Yes No n/a john.smith@example.com
firstName string Yes No n/a John
lastName string Yes No n/a Smith
company string Yes No n/a ABC Bank
title string Yes No n/a CEO
phoneNumber string Yes No n/a +15256951122