# Customer

## Get customer

> Get specific customer details

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersDtosResponsesCustomerCustomerDto":{"type":"object","additionalProperties":false,"properties":{"CustomerId":{"type":"string","description":"Customer ID","format":"guid"},"TenantId":{"type":"string","description":"Customer tenant ID","format":"guid"},"Name":{"type":"string","description":"Customer Name","nullable":true},"Email":{"type":"string","description":"Customer Email","nullable":true},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121","nullable":true},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"Optional external lookup ID. Can be used for searching","nullable":true},"CannotModify":{"type":"boolean","description":"Don't allow modification of this contact"},"Source":{"description":"Customer data source","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSource"}]},"CustomerEditLink":{"type":"string","description":"Link to edit customer details directly","nullable":true},"TotalLiveBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user which are yet to be actioned","format":"int32","nullable":true},"TotalBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user","format":"int32","nullable":true},"IsArchived":{"type":"boolean","description":"Customer is archived"},"PreferredName":{"type":"string","description":"Customer preferred name. The customer will be addressed by this name when signing.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsSource":{"type":"string","description":"","enum":["Manual","XPM","Test","CSV","External","APS","MYOB","FileFYI","FileIManage","FYIElite","Karbon","SyncedContact","FuseDocs"]},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Customer/Get":{"get":{"tags":["Customer"],"summary":"Get customer","description":"Get specific customer details","operationId":"ExternalApiExternalHandlersFeaturesCustomerGetGetCustomerEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}},{"name":"CustomerId","in":"query","required":true,"description":"Customer Id","schema":{"type":"string","format":"guid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesCustomerCustomerDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Create a new customer

> Create a new customer record

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersFeaturesCustomerCreateCreateCustomerRequest":{"type":"object","additionalProperties":false,"required":["Name","Email"],"properties":{"CustomerId":{"type":"string","format":"guid","deprecated":true,"nullable":true},"Name":{"type":"string","description":"Customer Name (Required)","minLength":1,"nullable":false},"Email":{"type":"string","description":"Customer Email (Required)","format":"email","minLength":1,"pattern":"^[^@]+@[^@]+$","nullable":false},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121"},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"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","maxLength":128,"minLength":0},"CannotModify":{"type":"boolean","description":"Prevents end users from modifying this contact within the FuseSign application"},"Options":{"description":"Options for contact creation and validation","oneOf":[{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosRequestsCustomerContactCreationOptionsDto"}]}}},"ExternalApiExternalHandlersDtosRequestsCustomerContactCreationOptionsDto":{"type":"object","additionalProperties":false,"properties":{"IgnorePhoneNumberIfInvalid":{"type":"boolean"},"UpdateExistingCustomersByMetaMatch":{"type":"boolean"}}},"ExternalApiExternalHandlersDtosResponsesCustomerCustomerDto":{"type":"object","additionalProperties":false,"properties":{"CustomerId":{"type":"string","description":"Customer ID","format":"guid"},"TenantId":{"type":"string","description":"Customer tenant ID","format":"guid"},"Name":{"type":"string","description":"Customer Name","nullable":true},"Email":{"type":"string","description":"Customer Email","nullable":true},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121","nullable":true},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"Optional external lookup ID. Can be used for searching","nullable":true},"CannotModify":{"type":"boolean","description":"Don't allow modification of this contact"},"Source":{"description":"Customer data source","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSource"}]},"CustomerEditLink":{"type":"string","description":"Link to edit customer details directly","nullable":true},"TotalLiveBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user which are yet to be actioned","format":"int32","nullable":true},"TotalBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user","format":"int32","nullable":true},"IsArchived":{"type":"boolean","description":"Customer is archived"},"PreferredName":{"type":"string","description":"Customer preferred name. The customer will be addressed by this name when signing.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsSource":{"type":"string","description":"","enum":["Manual","XPM","Test","CSV","External","APS","MYOB","FileFYI","FileIManage","FYIElite","Karbon","SyncedContact","FuseDocs"]},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Customer/Create":{"post":{"tags":["Customer"],"summary":"Create a new customer","description":"Create a new customer record","operationId":"ExternalApiExternalHandlersFeaturesCustomerCreateCreateCustomerEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersFeaturesCustomerCreateCreateCustomerRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesCustomerCustomerDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Search customer

> Search for customer based on Name/Email/Phone details

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersDtosResponsesCustomerCustomerDto":{"type":"object","additionalProperties":false,"properties":{"CustomerId":{"type":"string","description":"Customer ID","format":"guid"},"TenantId":{"type":"string","description":"Customer tenant ID","format":"guid"},"Name":{"type":"string","description":"Customer Name","nullable":true},"Email":{"type":"string","description":"Customer Email","nullable":true},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121","nullable":true},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"Optional external lookup ID. Can be used for searching","nullable":true},"CannotModify":{"type":"boolean","description":"Don't allow modification of this contact"},"Source":{"description":"Customer data source","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSource"}]},"CustomerEditLink":{"type":"string","description":"Link to edit customer details directly","nullable":true},"TotalLiveBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user which are yet to be actioned","format":"int32","nullable":true},"TotalBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user","format":"int32","nullable":true},"IsArchived":{"type":"boolean","description":"Customer is archived"},"PreferredName":{"type":"string","description":"Customer preferred name. The customer will be addressed by this name when signing.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsSource":{"type":"string","description":"","enum":["Manual","XPM","Test","CSV","External","APS","MYOB","FileFYI","FileIManage","FYIElite","Karbon","SyncedContact","FuseDocs"]},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Customer/Search":{"get":{"tags":["Customer"],"summary":"Search customer","description":"Search for customer based on Name/Email/Phone details","operationId":"ExternalApiExternalHandlersFeaturesCustomerSearchCustomerSearchEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}},{"name":"SearchString","in":"query","required":true,"description":"Wildcard search text","schema":{"type":"string"}},{"name":"CollapseDuplicates","in":"query","required":true,"description":"Collapse any duplicate records","schema":{"type":"boolean"}},{"name":"ExcludeArchived","in":"query","required":true,"description":"Exclude archived contacts","schema":{"type":"boolean"}},{"name":"IncludeLiveBundleCount","in":"query","description":"Include live bundle count","schema":{"type":"boolean","nullable":true}},{"name":"IncludeBundleCounts","in":"query","description":"Include live bundle count","schema":{"type":"boolean","nullable":true}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesCustomerCustomerDto"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## Search customer

> Search for customer based on metadata field

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiExternalHandlersDtosResponsesCustomerCustomerDto":{"type":"object","additionalProperties":false,"properties":{"CustomerId":{"type":"string","description":"Customer ID","format":"guid"},"TenantId":{"type":"string","description":"Customer tenant ID","format":"guid"},"Name":{"type":"string","description":"Customer Name","nullable":true},"Email":{"type":"string","description":"Customer Email","nullable":true},"PhoneNumber":{"type":"string","description":"Customer mobile number. Required for 2FA. If NoMobile is true this is not required. Must be in international format:   +61413121121","nullable":true},"NoMobile":{"type":"boolean","description":"No Mobile flag, means Phone Number is ignored"},"Meta":{"type":"string","description":"Optional external lookup ID. Can be used for searching","nullable":true},"CannotModify":{"type":"boolean","description":"Don't allow modification of this contact"},"Source":{"description":"Customer data source","oneOf":[{"$ref":"#/components/schemas/FuseWebSharedObjectsFuseSignEnumsSource"}]},"CustomerEditLink":{"type":"string","description":"Link to edit customer details directly","nullable":true},"TotalLiveBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user which are yet to be actioned","format":"int32","nullable":true},"TotalBundlesForCustomer":{"type":"integer","description":"Number of bundles assigned to the user","format":"int32","nullable":true},"IsArchived":{"type":"boolean","description":"Customer is archived"},"PreferredName":{"type":"string","description":"Customer preferred name. The customer will be addressed by this name when signing.","nullable":true}}},"FuseWebSharedObjectsFuseSignEnumsSource":{"type":"string","description":"","enum":["Manual","XPM","Test","CSV","External","APS","MYOB","FileFYI","FileIManage","FYIElite","Karbon","SyncedContact","FuseDocs"]},"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Customer/SearchByMetaData":{"get":{"tags":["Customer"],"summary":"Search customer","description":"Search for customer based on metadata field","operationId":"ExternalApiExternalHandlersFeaturesCustomerSearchByMetaDataSearchByMetaDataEndpoint","parameters":[{"name":"TenantId","in":"query","required":true,"description":"FuseSign Tenant Id","schema":{"type":"string","format":"guid"}},{"name":"MetaDataSearch","in":"query","required":true,"description":"Wildcard search text","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalApiExternalHandlersDtosResponsesCustomerCustomerDto"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```

## List country codes

> Gets the list of all country codes supported by the platform

```json
{"openapi":"3.0.0","info":{"title":"FuseSign API","version":"v1"},"servers":[{"url":"https://api.fuse.work","description":"FuseSign API"}],"security":[{"OAuthToken":[]},{"ApiKey":[]}],"components":{"securitySchemes":{"OAuthToken":{"type":"oauth2","description":"FuseSign OAuth 2. Use this for most implementations.","name":"FuseSign OAuth 2","flows":{"authorizationCode":{"authorizationUrl":"https://api.fuse.work/api/Session/OAuthRegister","tokenUrl":"https://api.fuse.work/api/Session/OAuthGetToken","refreshUrl":"https://api.fuse.work/api/Session/OAuthRefreshToken","scopes":{"FUSESIGN":"Manage FuseSign Bundles and corresponding data.","FUSESIGN:OWN":"Ability to send bundles and extract bundles created by this user only. Special purpose scope, contact support@fuse.work."}}}},"ApiKey":{"type":"apiKey","description":"Wholesale API Token","name":"X-API-Token","in":"header"}},"schemas":{"ExternalApiCommonModelsApiErrorResponse":{"type":"object","additionalProperties":false,"properties":{"Result":{"type":"boolean"},"Message":{"type":"string"},"Errors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FuseWebSharedObjectsModelsValidationError"}}}},"FuseWebSharedObjectsModelsValidationError":{"type":"object","additionalProperties":false,"properties":{"Property":{"type":"string"},"ErrorMessage":{"type":"string"},"ErrorCode":{"type":"string"}}}}},"paths":{"/api/Customer/GetCountryCodes":{"get":{"tags":["Customer"],"summary":"List country codes","description":"Gets the list of all country codes supported by the platform","operationId":"ExternalApiExternalHandlersFeaturesCustomerGetCountryCodesGetCountryCodesEndpoint","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalApiCommonModelsApiErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fuseworks.gitbook.io/fusesign/api-references/customer.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.