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

Example: 25fd0ba3-43ec-4dd7-b8e2-fed0e0bb3913
CustomerIdstring · guidRequired

Customer Id

Example: ff03398b-f251-454e-9cb6-a259642d04f8
Responses
200

Success

application/json
get
/api/Customer/Get
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,
  "PreferredName": "text"
}

Create a new customer

post

Create a new customer record

Authorizations
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 1b4d4826-f629-4dff-9cba-490bfa87a0d4
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

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
post
/api/Customer/Create
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,
  "PreferredName": "text"
}

Search customer

get

Search for customer based on Name/Email/Phone details

Authorizations
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: 205575c8-71fb-4297-87b2-e911b26ed323
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
get
/api/Customer/Search
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,
    "PreferredName": "text"
  }
]

Search customer

get

Search for customer based on metadata field

Authorizations
Query parameters
TenantIdstring · guidRequired

FuseSign Tenant Id

Example: f087d4f0-ddb2-4ee6-b18c-654f9639307c
MetaDataSearchstringRequired

Wildcard search text

Example: meta
Responses
200

Success

application/json
get
/api/Customer/SearchByMetaData
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,
    "PreferredName": "text"
  }
]

List country codes

get

Gets the list of all country codes supported by the platform

Authorizations
Responses
200

Success

application/json
Responsestring[]
get
/api/Customer/GetCountryCodes
GET /api/Customer/GetCountryCodes HTTP/1.1
Host: api.fuse.work
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "text"
]
PreviousBundleNextDocument

Last updated