This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Get contact

GET

https://api.signater.com/v1/ecm/contacts/{contactId}

Contact

Last modified:2025-03-29 12:47:42

Retrieves detailed information about a specific contact by its unique identifier. This endpoint is useful for viewing or validating contact data before creating or updating related entities. Ensure the provided contact ID exists in the system.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Path Params

contactId

string <uuid>

required

Contact ID

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Contact retrieved successfully

Body

string <uuid>

optional

Id of the contact

name

string | null

optional

Name of the contact

role

enum<string> | enum<null>

optional

Role of the contact

Allowed values:

SignApproveRecognizeTestifyConfirmReceivingEndorseInBlackEndorseInWhiteConfirm

title

string | null

optional

Title of the contact

string | null

optional

Email address of the contact

phoneIdd

integer <int32> | null

optional

Phone IDD of the contact, e.g. '1' for the United States or '55' for Brazil

phoneNumber

string | null

optional

Phone number of the contact excluding the IDD

documentType

enum<string> | enum<null>

optional

Document type of the contact

Allowed values:

GenericIdentificationBrazilianCpf

documentValue

string | null

optional

Document value of the contact

description

string | null

optional

Description of the contact

Example

{
  "id": "54e0112d-08dd-4efd-a033-d015046b3c66",
  "name": "John Doe",
  "role": "Confirm",
  "title": "Company Director",
  "email": "john.doe@example.com",
  "phoneIdd": 1,
  "phoneNumber": "5555555555",
  "documentType": "GenericIdentification",
  "documentValue": "123456789",
  "description": "This is a description"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-03-29 12:47:42

Create contact

Update contact