Account Custom Fields

An Account Custom Field is a Custom Field that has been added to an Account.

This section describes the following services for such fields:

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

Find an Account Custom Field by ID

GET /account/customfields/{customFieldId}

Description

Find an Account Custom Field by its ID.

Resource Information

HTTP Method GET
Resource Family account/customfields
Authentication See Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

customeFieldId ID of the Custom Field to be retrieved

Example Request

GET https://sandbox.e-signlive.com/api/account/customfields/DOB

Add a Custom Field to an Account

POST /account/customfields

Description

Add a Custom Field to an Account.

Resource Information

HTTP Method POST
Resource Family account/customfields
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Example Request

POST https://sandbox.e-signlive.com/api/account/customfields

Update an Account Custom Field

PUT /account/customfields

Description

Update an Account Custom Field.

Resource Information

HTTP Method PUT
Resource Family account/customfields
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Path Parameters

groupId Unique identifier of a OneSpan Sign group

Example Request

PUT https://sandbox.e-signlive.com/api/account/customfields

Delete an Account Custom Field by ID

DELETE /account/customfields/{customFieldId}

Description

Delete an Account Custom Field by its ID.

Resource Information

HTTP Method DELETE
Resource Family account/customfields
Authentication Authentication Tokens
Content-type application/json
Accept application/json

Required Parameters

customeFieldId ID of the Custom Field to be deleted

Example Request

DELETE https://sandbox.e-signlive.com/api/account/customfields/DOB

Response Payload

no content