Customer

The person who will be receiving the signing action.

Get customer

get

Get specific customer details

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant Id

customerIdstring · guidRequired

Customer Id

Responses
200
Success
application/json
get
GET /api/Customer/Get 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
}

Create a new customer

post

Create a new customer record

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant Id

Body
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: +61413121121

noMobilebooleanOptional

No Mobile flag, means Phone Number is ignored

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

optionsone ofOptional

Options for contact creation and validation

Responses
200
Success
application/json
post
POST /api/Customer/Create 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
}
get

Search for customer based on Name/Email/Phone details

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant Id

searchStringstringRequired

Wildcard search text

collapseDuplicatesbooleanRequired

Collapse any duplicate records

excludeArchivedbooleanRequired

Exclude archived contacts

includeLiveBundleCountboolean | nullableOptional

Include live bundle count

includeBundleCountsboolean | nullableOptional

Include live bundle count

Responses
200
Success
application/json
get
GET /api/Customer/Search 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
  }
]

Search customer

get

Search for customer based on metadata field

Authorizations
Query parameters
tenantIdstring · guidRequired

FuseSign Tenant Id

metaDataSearchstringRequired

Wildcard search text

Responses
200
Success
application/json
get
GET /api/Customer/SearchByMetaData 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
  }
]

List country codes

get

Gets the list of all country codes supported by the platform

Authorizations
Responses
200
Success
application/json
Responsestring[]
get
GET /api/Customer/GetCountryCodes HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  "text"
]

Last updated