Customer

The person who will be receiving the signing action.

Get customer

get

Get specific customer details

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 49c2e188-c18e-495b-86c9-08062686ac28

CustomerIdstring · guidRequired

Customer Id

Example: 7237a4e3-5910-45de-a4fa-2e9fba41f49d

Responses

200

Success

application/json

CustomerIdstring · guidOptional

Customer ID

TenantIdstring · guidOptional

Customer tenant ID

Namestring · nullableOptional

Customer Name

Emailstring · nullableOptional

Customer Email

PhoneNumberstring · nullableOptional

Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format: [phone]

NoMobilebooleanOptional

No Mobile flag, means Phone Number is ignored

Metastring · nullableOptional

Optional external lookup ID. Can be used for searching

CannotModifybooleanOptional

Don't allow modification of this contact

Sourceone ofOptional

Customer data source

string · enumOptionalPossible values:

CustomerEditLinkstring · nullableOptional

Link to edit customer details directly

TotalLiveBundlesForCustomerinteger · int32 · nullableOptional

Number of bundles assigned to the user which are yet to be actioned

TotalBundlesForCustomerinteger · int32 · nullableOptional

Number of bundles assigned to the user

IsArchivedbooleanOptional

Customer is archived

PreferredNamestring · nullableOptional

Customer preferred name. The customer will be addressed by this name when signing.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

get

/api/Customer/Get

HTTPcURLJavaScriptPython

GET /api/Customer/Get?TenantId=text&CustomerId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "CustomerId": "text",
  "TenantId": "text",
  "Name": "text",
  "Email": "text",
  "PhoneNumber": "text",
  "NoMobile": true,
  "Meta": "text",
  "CannotModify": true,
  "Source": "Manual",
  "CustomerEditLink": "text",
  "TotalLiveBundlesForCustomer": 1,
  "TotalBundlesForCustomer": 1,
  "IsArchived": true,
  "PreferredName": "text"
}

Create a new customer

post

Create a new customer record

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: c4cdddae-5c3d-47ee-a652-50852c26a9c1

Body

application/json

CustomerIdstring · guid · nullableOptionalDeprecated

Namestring · min: 1Required

Customer Name (Required)

Emailstring · email · min: 1Required

Customer Email (Required)

Pattern: ^[^@]+@[^@]+$

PhoneNumberstringOptional

Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format: [phone]

NoMobilebooleanOptional

No Mobile flag, means Phone Number is ignored

Example: false

Metastring · max: 128Optional

Optional external lookup ID. Can be used for searching later. Note: This is used to uniquely identify this contact and will cause duplicate contacts if not reused

CannotModifybooleanOptional

Prevents end users from modifying this contact within the FuseSign application

Example: false

Optionsone ofOptional

Options for contact creation and validation

Example: {"IgnorePhoneNumberIfInvalid":false,"UpdateExistingCustomersByMetaMatch":false}

Responses

200

Success

application/json

CustomerIdstring · guidOptional

Customer ID

TenantIdstring · guidOptional

Customer tenant ID

Namestring · nullableOptional

Customer Name

Emailstring · nullableOptional

Customer Email

PhoneNumberstring · nullableOptional

Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format: [phone]

NoMobilebooleanOptional

No Mobile flag, means Phone Number is ignored

Metastring · nullableOptional

Optional external lookup ID. Can be used for searching

CannotModifybooleanOptional

Don't allow modification of this contact

Sourceone ofOptional

Customer data source

string · enumOptionalPossible values:

CustomerEditLinkstring · nullableOptional

Link to edit customer details directly

TotalLiveBundlesForCustomerinteger · int32 · nullableOptional

Number of bundles assigned to the user which are yet to be actioned

TotalBundlesForCustomerinteger · int32 · nullableOptional

Number of bundles assigned to the user

IsArchivedbooleanOptional

Customer is archived

PreferredNamestring · nullableOptional

Customer preferred name. The customer will be addressed by this name when signing.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

post

/api/Customer/Create

HTTPcURLJavaScriptPython

POST /api/Customer/Create?TenantId=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "CustomerId": null,
  "Name": "",
  "Email": "",
  "PhoneNumber": "",
  "NoMobile": false,
  "Meta": "",
  "CannotModify": false,
  "Options": {
    "IgnorePhoneNumberIfInvalid": false,
    "UpdateExistingCustomersByMetaMatch": false
  }
}

{
  "CustomerId": "text",
  "TenantId": "text",
  "Name": "text",
  "Email": "text",
  "PhoneNumber": "text",
  "NoMobile": true,
  "Meta": "text",
  "CannotModify": true,
  "Source": "Manual",
  "CustomerEditLink": "text",
  "TotalLiveBundlesForCustomer": 1,
  "TotalBundlesForCustomer": 1,
  "IsArchived": true,
  "PreferredName": "text"
}

Search customer

get

Search for customer based on Name/Email/Phone details

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 5d816d20-de5e-42ca-8a72-9002bfc96cd1

SearchStringstringRequired

Wildcard search text

CollapseDuplicatesbooleanRequired

Collapse any duplicate records

Example: false

ExcludeArchivedbooleanRequired

Exclude archived contacts

Example: true

IncludeLiveBundleCountboolean · nullableOptional

Include live bundle count

IncludeBundleCountsboolean · nullableOptional

Include live bundle count

Responses

200

Success

application/json

CustomerIdstring · guidOptional

Customer ID

TenantIdstring · guidOptional

Customer tenant ID

Namestring · nullableOptional

Customer Name

Emailstring · nullableOptional

Customer Email

PhoneNumberstring · nullableOptional

Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format: [phone]

NoMobilebooleanOptional

No Mobile flag, means Phone Number is ignored

Metastring · nullableOptional

Optional external lookup ID. Can be used for searching

CannotModifybooleanOptional

Don't allow modification of this contact

Sourceone ofOptional

Customer data source

string · enumOptionalPossible values:

CustomerEditLinkstring · nullableOptional

Link to edit customer details directly

TotalLiveBundlesForCustomerinteger · int32 · nullableOptional

Number of bundles assigned to the user which are yet to be actioned

TotalBundlesForCustomerinteger · int32 · nullableOptional

Number of bundles assigned to the user

IsArchivedbooleanOptional

Customer is archived

PreferredNamestring · nullableOptional

Customer preferred name. The customer will be addressed by this name when signing.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

get

/api/Customer/Search

HTTPcURLJavaScriptPython

GET /api/Customer/Search?TenantId=text&SearchString=text&CollapseDuplicates=true&ExcludeArchived=true HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "CustomerId": "text",
    "TenantId": "text",
    "Name": "text",
    "Email": "text",
    "PhoneNumber": "text",
    "NoMobile": true,
    "Meta": "text",
    "CannotModify": true,
    "Source": "Manual",
    "CustomerEditLink": "text",
    "TotalLiveBundlesForCustomer": 1,
    "TotalBundlesForCustomer": 1,
    "IsArchived": true,
    "PreferredName": "text"
  }
]

Search customer

get

Search for customer based on metadata field

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Query parameters

TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 2d1bbc67-4c9d-44cf-a95d-8995d9253082

MetaDataSearchstringRequired

Wildcard search text

Example: meta

Responses

200

Success

application/json

CustomerIdstring · guidOptional

Customer ID

TenantIdstring · guidOptional

Customer tenant ID

Namestring · nullableOptional

Customer Name

Emailstring · nullableOptional

Customer Email

PhoneNumberstring · nullableOptional

Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format: [phone]

NoMobilebooleanOptional

No Mobile flag, means Phone Number is ignored

Metastring · nullableOptional

Optional external lookup ID. Can be used for searching

CannotModifybooleanOptional

Don't allow modification of this contact

Sourceone ofOptional

Customer data source

string · enumOptionalPossible values:

CustomerEditLinkstring · nullableOptional

Link to edit customer details directly

TotalLiveBundlesForCustomerinteger · int32 · nullableOptional

Number of bundles assigned to the user which are yet to be actioned

TotalBundlesForCustomerinteger · int32 · nullableOptional

Number of bundles assigned to the user

IsArchivedbooleanOptional

Customer is archived

PreferredNamestring · nullableOptional

Customer preferred name. The customer will be addressed by this name when signing.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

get

/api/Customer/SearchByMetaData

HTTPcURLJavaScriptPython

GET /api/Customer/SearchByMetaData?TenantId=text&MetaDataSearch=text HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "CustomerId": "text",
    "TenantId": "text",
    "Name": "text",
    "Email": "text",
    "PhoneNumber": "text",
    "NoMobile": true,
    "Meta": "text",
    "CannotModify": true,
    "Source": "Manual",
    "CustomerEditLink": "text",
    "TotalLiveBundlesForCustomer": 1,
    "TotalBundlesForCustomer": 1,
    "IsArchived": true,
    "PreferredName": "text"
  }
]

List country codes

get

Gets the list of all country codes supported by the platform

Authorizations

OAuthTokenApiKey

OAuth2authorizationCodeRequired

FuseSign OAuth 2. Use this for most implementations.

Authorization URL: Token URL: Refresh URL:

Responses

200

Success

application/json

string[]Optional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

get

/api/Customer/GetCountryCodes

HTTPcURLJavaScriptPython

GET /api/Customer/GetCountryCodes HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "text"
]