[//]: # (block-start:title)

libvf

[//]: # (block-stop:title)

[//]: # (block-start:summary)

Javascript wrapper for the Verified API, for use in the browser.

[//]: # (block-stop:summary)

Links

* libvf documentation
* The official Verified API documentation
* Find this package on NPM
* CDN for this package

Getting started

$3

ES6 imports
``javascript
import * as libvf from 'libvf'

// Or specify which modules to import

import { auth, envelopes, companies, oidc } from 'libvf'
`

From CDN


creates a global object libvf
`html

`




$3


Using your Verified credentials

Namespace is optional, but you will not be able to act on behalf of a company without it.
`javascript
const jwt = await libvf.auth.login({
email: 'john.doe@example.com',
password: '*',
namespace: '/companies/your_company_id'
})
`

Using an existing JWT
`javascript
libvf.auth.setToken('JWT ey...')
libvf.auth.setNamespace('/companies/your_company_id')
`


Getting the JWT and namespace from the URL parameters

Looks for the url parameters verified_token or access_token for the jwt, and c or namespace for the namespace. If not found, an error will be thrown.
`javascript
libvf.auth.useTokenFromUrl()
`

$3


Requires a descriptor id as argument, in most cases this will be default.
`javascript
let envelope = await libvf.envelopes.create('default')
`

$3

With the steps above completed, we now have an envelope object which references the envelope stored in the API. In order to get the data stored in the API into our local object, we need to reflect any recent changes.
`javascript
await envelope.reflect()
`
This makes a request to the API, reads all of the envelope data, parses it and creates local instances of any documents, recipients, templates etc in our local object.

$3

Uploading the main pdf to a document
`javascript
await envelope.firstDocument().uploadPDF('Story of the padded one.pdf', fileBinary)
`

Uploading an attachment to a document
`javascript
await envelope.firstDocument().uploadAttachment('Story of the deploy man.txt', fileBinary)
`

$3


`javascript
await envelope.addRecipient({
givenName: "John",
familyName: "Doe",
language: "en_EN",
signingMethod: "email",
email: "john.doe@example.com",
order: 1,
role: {
action: "sign",
label: "Signatory",
name: "signer"
}
})
`

$3

`javascript
await envelope.publish()
``