Files

27 KiB

\EsignAPI

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
GetEsignDocuments Get /v1/esign/documents Returns your org's documents, newest first.
GetEsignDocumentsById Get /v1/esign/documents/{id} Returns one document with its recipients and field layout.
GetEsignDocumentsByIdAudit Get /v1/esign/documents/{id}/audit Returns the document's full audit trail, oldest first.
GetEsignDocumentsByIdDownload Get /v1/esign/documents/{id}/download Returns the document — the sealed PDF once it is complete.
GetEsignHealth Get /v1/esign/health Reports whether the e-signature surface is mounted.
GetEsignOByOrgSignByToken Get /v1/esign/o/{org}/sign/{token} Opens a document you were asked to sign, using your signing link.
PostEsignDocuments Post /v1/esign/documents Uploads a PDF and opens a draft ready for recipients and fields.
PostEsignDocumentsByIdFields Post /v1/esign/documents/{id}/fields Places a field on the page for one recipient to fill.
PostEsignDocumentsByIdRecipients Post /v1/esign/documents/{id}/recipients Adds someone to a draft and mints their signing token.
PostEsignDocumentsByIdSend Post /v1/esign/documents/{id}/send Sends the document out and answers each signer's link.
PostEsignOByOrgSignByTokenComplete Post /v1/esign/o/{org}/sign/{token}/complete Finishes your signing — and seals the document if you were the last.
PostEsignOByOrgSignByTokenFieldsByFieldid Post /v1/esign/o/{org}/sign/{token}/fields/{fieldId} Fills in one of your fields.
PostEsignOByOrgSignByTokenReject Post /v1/esign/o/{org}/sign/{token}/reject Declines to sign, with an optional reason.

GetEsignDocuments

EsignEsignDocuments GetEsignDocuments(ctx).Execute()

Returns your org's documents, newest first.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.GetEsignDocuments(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.GetEsignDocuments``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEsignDocuments`: EsignEsignDocuments
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.GetEsignDocuments`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetEsignDocumentsRequest struct via the builder pattern

Return type

EsignEsignDocuments

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEsignDocumentsById

EsignEsignDocument GetEsignDocumentsById(ctx, id).Execute()

Returns one document with its recipients and field layout.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id belonging to another tenant is simply not found.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.GetEsignDocumentsById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.GetEsignDocumentsById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEsignDocumentsById`: EsignEsignDocument
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.GetEsignDocumentsById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id belonging to another tenant is simply not found.

Other Parameters

Other parameters are passed through a pointer to a apiGetEsignDocumentsByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

EsignEsignDocument

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEsignDocumentsByIdAudit

EsignEsignTrail GetEsignDocumentsByIdAudit(ctx, id).Execute()

Returns the document's full audit trail, oldest first.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id belonging to another tenant is simply not found.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.GetEsignDocumentsByIdAudit(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.GetEsignDocumentsByIdAudit``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEsignDocumentsByIdAudit`: EsignEsignTrail
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.GetEsignDocumentsByIdAudit`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id belonging to another tenant is simply not found.

Other Parameters

Other parameters are passed through a pointer to a apiGetEsignDocumentsByIdAuditRequest struct via the builder pattern

Name Type Description Notes

Return type

EsignEsignTrail

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEsignDocumentsByIdDownload

EsignEsignPDF GetEsignDocumentsByIdDownload(ctx, id).Execute()

Returns the document — the sealed PDF once it is complete.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id belonging to another tenant is simply not found.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.GetEsignDocumentsByIdDownload(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.GetEsignDocumentsByIdDownload``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEsignDocumentsByIdDownload`: EsignEsignPDF
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.GetEsignDocumentsByIdDownload`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the document to act on. It is the path segment: the URL is the addressing authority, and the org it is resolved in comes from the caller's principal, so an id belonging to another tenant is simply not found.

Other Parameters

Other parameters are passed through a pointer to a apiGetEsignDocumentsByIdDownloadRequest struct via the builder pattern

Name Type Description Notes

Return type

EsignEsignPDF

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEsignHealth

EsignEsignHealth GetEsignHealth(ctx).Execute()

Reports whether the e-signature surface is mounted.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.GetEsignHealth(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.GetEsignHealth``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEsignHealth`: EsignEsignHealth
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.GetEsignHealth`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetEsignHealthRequest struct via the builder pattern

Return type

EsignEsignHealth

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEsignOByOrgSignByToken

EsignEsignSession GetEsignOByOrgSignByToken(ctx, org, token).Execute()

Opens a document you were asked to sign, using your signing link.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	org := "org_example" // string | 
	token := "token_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.GetEsignOByOrgSignByToken(context.Background(), org, token).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.GetEsignOByOrgSignByToken``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEsignOByOrgSignByToken`: EsignEsignSession
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.GetEsignOByOrgSignByToken`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
org string
token string

Other Parameters

Other parameters are passed through a pointer to a apiGetEsignOByOrgSignByTokenRequest struct via the builder pattern

Name Type Description Notes

Return type

EsignEsignSession

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostEsignDocuments

EsignEsignDocument PostEsignDocuments(ctx).EsignEsignUploadIn(esignEsignUploadIn).Execute()

Uploads a PDF and opens a draft ready for recipients and fields.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	esignEsignUploadIn := *openapiclient.NewEsignEsignUploadIn() // EsignEsignUploadIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.PostEsignDocuments(context.Background()).EsignEsignUploadIn(esignEsignUploadIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.PostEsignDocuments``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostEsignDocuments`: EsignEsignDocument
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.PostEsignDocuments`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostEsignDocumentsRequest struct via the builder pattern

Name Type Description Notes
esignEsignUploadIn EsignEsignUploadIn

Return type

EsignEsignDocument

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostEsignDocumentsByIdFields

EsignEsignPlacement PostEsignDocumentsByIdFields(ctx, id).EsignEsignFieldIn(esignEsignFieldIn).Execute()

Places a field on the page for one recipient to fill.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | 
	esignEsignFieldIn := *openapiclient.NewEsignEsignFieldIn() // EsignEsignFieldIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.PostEsignDocumentsByIdFields(context.Background(), id).EsignEsignFieldIn(esignEsignFieldIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.PostEsignDocumentsByIdFields``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostEsignDocumentsByIdFields`: EsignEsignPlacement
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.PostEsignDocumentsByIdFields`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiPostEsignDocumentsByIdFieldsRequest struct via the builder pattern

Name Type Description Notes

esignEsignFieldIn | EsignEsignFieldIn | |

Return type

EsignEsignPlacement

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostEsignDocumentsByIdRecipients

EsignEsignInvite PostEsignDocumentsByIdRecipients(ctx, id).EsignEsignRecipientIn(esignEsignRecipientIn).Execute()

Adds someone to a draft and mints their signing token.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | 
	esignEsignRecipientIn := *openapiclient.NewEsignEsignRecipientIn() // EsignEsignRecipientIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.PostEsignDocumentsByIdRecipients(context.Background(), id).EsignEsignRecipientIn(esignEsignRecipientIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.PostEsignDocumentsByIdRecipients``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostEsignDocumentsByIdRecipients`: EsignEsignInvite
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.PostEsignDocumentsByIdRecipients`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiPostEsignDocumentsByIdRecipientsRequest struct via the builder pattern

Name Type Description Notes

esignEsignRecipientIn | EsignEsignRecipientIn | |

Return type

EsignEsignInvite

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostEsignDocumentsByIdSend

EsignEsignLinks PostEsignDocumentsByIdSend(ctx, id).Execute()

Sends the document out and answers each signer's link.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	id := "id_example" // string | ID is the document to send. The URL is the addressing authority.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.PostEsignDocumentsByIdSend(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.PostEsignDocumentsByIdSend``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostEsignDocumentsByIdSend`: EsignEsignLinks
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.PostEsignDocumentsByIdSend`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID is the document to send. The URL is the addressing authority.

Other Parameters

Other parameters are passed through a pointer to a apiPostEsignDocumentsByIdSendRequest struct via the builder pattern

Name Type Description Notes

Return type

EsignEsignLinks

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostEsignOByOrgSignByTokenComplete

EsignEsignCompletion PostEsignOByOrgSignByTokenComplete(ctx, org, token).Execute()

Finishes your signing — and seals the document if you were the last.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	org := "org_example" // string | 
	token := "token_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.PostEsignOByOrgSignByTokenComplete(context.Background(), org, token).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.PostEsignOByOrgSignByTokenComplete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostEsignOByOrgSignByTokenComplete`: EsignEsignCompletion
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.PostEsignOByOrgSignByTokenComplete`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
org string
token string

Other Parameters

Other parameters are passed through a pointer to a apiPostEsignOByOrgSignByTokenCompleteRequest struct via the builder pattern

Name Type Description Notes

Return type

EsignEsignCompletion

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostEsignOByOrgSignByTokenFieldsByFieldid

EsignEsignInsertion PostEsignOByOrgSignByTokenFieldsByFieldid(ctx, org, token, fieldId).EsignEsignValueIn(esignEsignValueIn).Execute()

Fills in one of your fields.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	org := "org_example" // string | 
	token := "token_example" // string | 
	fieldId := "fieldId_example" // string | 
	esignEsignValueIn := *openapiclient.NewEsignEsignValueIn() // EsignEsignValueIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.PostEsignOByOrgSignByTokenFieldsByFieldid(context.Background(), org, token, fieldId).EsignEsignValueIn(esignEsignValueIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.PostEsignOByOrgSignByTokenFieldsByFieldid``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostEsignOByOrgSignByTokenFieldsByFieldid`: EsignEsignInsertion
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.PostEsignOByOrgSignByTokenFieldsByFieldid`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
org string
token string
fieldId string

Other Parameters

Other parameters are passed through a pointer to a apiPostEsignOByOrgSignByTokenFieldsByFieldidRequest struct via the builder pattern

Name Type Description Notes

esignEsignValueIn | EsignEsignValueIn | |

Return type

EsignEsignInsertion

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostEsignOByOrgSignByTokenReject

EsignEsignRejection PostEsignOByOrgSignByTokenReject(ctx, org, token).EsignEsignRejectIn(esignEsignRejectIn).Execute()

Declines to sign, with an optional reason.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/hanzoai/go-sdk/v8"
)

func main() {
	org := "org_example" // string | 
	token := "token_example" // string | 
	esignEsignRejectIn := *openapiclient.NewEsignEsignRejectIn() // EsignEsignRejectIn | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EsignAPI.PostEsignOByOrgSignByTokenReject(context.Background(), org, token).EsignEsignRejectIn(esignEsignRejectIn).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EsignAPI.PostEsignOByOrgSignByTokenReject``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostEsignOByOrgSignByTokenReject`: EsignEsignRejection
	fmt.Fprintf(os.Stdout, "Response from `EsignAPI.PostEsignOByOrgSignByTokenReject`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
org string
token string

Other Parameters

Other parameters are passed through a pointer to a apiPostEsignOByOrgSignByTokenRejectRequest struct via the builder pattern

Name Type Description Notes

esignEsignRejectIn | EsignEsignRejectIn | |

Return type

EsignEsignRejection

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]