Getting Started

Authentication

ClientIds

Using Customer/Vendor Numbers

Filtering

HTTP Status Codes

Relationships and Saving Data

Error Messages

Cross Origin Resource Sharing

AWS SQS Integration

Retrieve all attribute groups for an account.

To access your companies client ID, it is available from Company Settings -> Company Details -> Company ID

x-client-id

The attribute group object you wish to update.

body

Delete an attribute group from a company.  Note - An attribute group can not be deleted if it is in use.

To access a client ID, it is available from Company Settings -> Company Details -> Company ID

No Content - Indicates the record was deleted.

Retrieves the details of an attribute group.

Update the details of an attribute group.

Delete an attribute from a company.  Note:  You can not delete an attribute that is in use.

The id of the attribute object returned by /v2/attributes

Provides a bearer token that will last for an hour.  You can use /v2/auth/refresh-token to extend the time.
      Note:  This is NOT for eCommerce.  Please refer to to the eCommerce section.

Provides a bearer token that will last for an hour.

Refreshes a bearer token for an hour.  To refresh your token, make this call but for authorization use you bearer token rather than your REST API credentials.
     To test this out in swagger, get a bearer token and then use the Authenticate button, at the top of the page, and authenticate using your bearer token, and then come back here and click Try it Now.
     Note:  This is NOT for eCommerce.  Please refer to to the eCommerce section.

Retrieve all Certificate Attributes for an account.

The certificate attribute group object you wish to update.

The id of the certificate attribute object.

Retrieving a single certificate attribute.

The certificate attribute object you wish to update.

Minimum Fields Required To Create A Certificate: filename OR pdf (urlencoded base64 pdf) OR pages (an array of urlencoded base64 images.) AND exposure_zone Submitting A New Certificate To A Stack: 
 If you wish to submit a created certificate to a stack, simply add the below value to your post request and it will appear in Data Entry. submit_to_stack=true

The certificate file name that was uploaded.

filename

signed_date

expiration_date

tax_number

tax_number_type

valid

is_single

The exposure zone that the certificate covers.

exposure_zone

The expected tax code of the certificate.

expected_tax_code

Delete a certificate from a company. Note: You can not delete a certificate that has customers associated with it. Use the /v2/certificates/<id>/customers endpoint to remove a customer from a certificate.

To access a client ID, it is available from Company Settings -> Company Details ->  Company ID

Update the data points for a certificate.

Need to pass in the attribute id that you want to remove from your certificate.

attributes

Retrieve all attributes for a certificate.

Need to pass in the attribute id that you want to associate with your certificate.

Delete a custom field from a certificate.

Need to pass in the custom field id that you want to associate with your certificate.

custom_fields

Retrieve all custom fields for a certificate.

Need to pass in the custom field id, and new value that you want to update.

Update a certificate's custom field value.

Delete a customer from a certificate.  Note - This does not remove the customer from the system.

Need to pass in the customer number that you want to remove from your certificate.

customers

Retrieve all customers associated with a certificate.

Need to pass in the customer number that you want to associate with your certificate.

Retrieve the image of the certificate as binary.

Retrieve the history of a certificate. Relationship: Read Only. Histories are generated internally and are read-only.

Delete an invalid reason from a certificate.  Note - This does not remove the invalid reason from the system.

Need to pass in the invalid reason  id that you want to associate with your certificate.

invalid_reasons

Delete an invalid reason from a certificate.

Retrieve all invalid reasons for a certificate.

Retrieve a certificate's invalid reasons.

Need to pass in the invalid reason id that you want to associate with your certificate.

Associate an invalid reason with a certificate.

Need to pass in the jobs id that you want to associate with your certificate.

jobs

Need to pass in the log id that you want to remove from your certificate.

logs

Need to pass in the account, the user listed as adding the log entry, and the entry that you want to associate with your certificate.

Retrieve the multi relationships of a certificate. Relationship: One To Many

Retrieve the certificates that are related via a multi jurisdictional certificate.

The id of the purchase order number that you want to remove from your certificate.

po_numbers

Retrieve all associated po-numbers for a certificate.

The purchase order number that is associated with your certificate.

The purchase order id number and it's new value, that you want to update for your certificate.

Upload certificate images by page in urlencoded base64 format to create/update current certificate images on file. Note:
 Uploading new certificate images will overwrite any uploaded PDF currently on file. Supported Image Types - JPEG, TIFF, PNG.

Upload a pdf to a certificate.  NOTE:  Certificate images will be automatically generated upon a successful upload.

Retrieve all clients/companies for an account.

Get a list of all countries for a given company.

To access a client ID, it is available from Company Settings -> Company Details -> Company ID. 

To access a client ID, it is available from Company Settings -> Company Details  -> Company Details -> Company ID.

The id of the Country object returned by v2/countries

The id of the country object returned by /v2/countries

To access a client ID, it is available from Company Settings -> Company Details -> Company ID.

Retrieve all cover letters, at the company level.

To access your companies client ID, it is available from Company Settings -> Company Details -> Company ID.

Create a cover letter at the company level.

The cover letter object you wish to create.

Retrieve a single cover letter from a company.

The cover letter object you wish to update.

Retrieve all Customer Attributes for an account.

Create a customer attribute that can be associated with a customer later.

The customer attribute group object you wish to update.

Delete a customer attribute from a company.  Note - A customer attribute can not be removed if it is currently in use.

Retrieve the details of a customer attribute.

Update the details of a customer attribute.

The customer attribute object you wish to update.

Create a customer within a company. Minimum Fields Required To Create a Customer: customer_number Want To Add A Vendor Record? Use is_vendor = true in the body of your POST request. States with Duplicate Initials: CertCapture has state information for a number of countries that have duplicate state initials. 
 Washington and Western Australia,Hawaii and Hidalgo If you are creating a customer in Washington, simply include the country as well or use the states full name.

To access a client ID, it is available from Company Settings -> Company Details

The customer number is a unique number, per company, for a customer.

customer_number

alternate_id

name

An optional attention name field for your customer.

attn_name

address_line1

The second line of the customers address.

address_line2

city

phone_number

fax_number

email_address

contact_name

state

country

Rather than checking to see if a customer record exists before creating, you can make an upsert call instead.

Use this to have the system generate a new incremental customer number.

The id of the customer object you wish to delete.

Retrieve a customer record from a company.

The id of the customer record you which to obtain.

Retrieve a customers active certificates.  Active certificates are generated internally and are read-only.

Retrieve a customers active certificates.

Remove a customer attribute from a customer.  Note - This breaks the association, but does not delete the customer attribute from the system.

Need to pass in the attribute id that you want to associate with your customer.

Remove a customer attribute from a customer.

Need to pass in the customer attribute id that you want to associate with your customer.  To get a list, use /v2/customer-attributes.

Unassociate a billto customer from a customer.

Need to pass in the customer id that you want to associate with your customer.

bill_tos

Associate a customer to a customer, in a bill to relationship.

Associate a billto customer to a customer.

Retrieve all billto customers, and their data, associated with a customer.

Retrieve all billto customers associated with a customer.

Unassociate a certificate from a customer.

Need to pass in the certificate id that you want to unassociate from your customer.

certificates

Retrieve all certificates, and associated data, for a customer.

Retrieve all certificates for a customer.

Need to pass in the certificates id that you want to associate with your customer.

Retrieve all custom-fields, and their data points, associated with a customer.

Retrieve all custom-fields associated with a customer.

Associate a custom-field to a customer.  You can use this endpoint to both add a value to a custom-field, as well as update a custom-fields value.

Need to pass in the custom field id and it's value that you want to associate with your customer.

Retrieve all exempt-reasons associated with a customer.  Note - Exempt Reasons are generated internally and are read-only

Remove an exposure-zone from a customer.  NOTE - This does not remove the exposure zone from the system.

Need to pass in the exposure-zone id that you want to remove from your customer.

exposure_zones

Retrieve all exposure-zones associated with a customer.

Need to pass in the exposure-zone id that you want to add your customer.  NOTE:  When testing below, you will need to wrap the object in [ ]'s.

Associate an exposure zone with a customer.

Retrieve all histories associated with a customer.  Histories are generated internally and are read-only.

Retrieve all histories associated with a customer.

Retrieve a customers inactive certificates.  Inactive certificates are generated internally and are read-only.

Retrieve a customers inactive certificates.

Remove a job from a customer. Note - Pass in Jobs object w Job ID to delete:  jobs=[{"id":"1"}] 

Need to pass in the jobs id that you want to remove from your customer.

Retrieve all jobs for a customer from a company.

Need to pass in the jobs id that you want to associate with your customer.

Retrieve all logs for a customer from a company.

Create a log and attach it to a customer.  Note:  Pass in log object, with account and entry:  logs=[{"account":"api log name", "entry":"test entry one"}]

Need to pass in the account used to create the log, and the entry itself, that you want to associate with your customer.

Delete a manual-overrides from a customer.

Need to pass in the manual overrides id that you want to unassociate from your customer.

manual_overrides

Retrieve all manual-overrides a customer.

Retrieve all manual-overrides for a customer.

Create a customer manual-override.  You will need to provide the following:  license_number, exposure_zone_id, tax_code_id.  Note:  n the certcapture system exempt reasons are considered tax codes. So please provide an exposure_zone_id and a tax_code_id when creating a customer manual tax override.

Unassociate a same-as customer from a customer.

Need to pass in the same-as id that you want to unassociate with your customer.

same-as

Retrieve all same-as customers associated with a customer.

Associate a customer with a customer, in a same-as relationship.

Need to pass in the customer number that you want to set as a same-as customer with your customer.

same_as

Associate a same-as customer to a customer.

Unassociate a ship to customer from a customer.

Need to pass in the customer id that you want to unassociate with your customer.

ship_tos

Retrieve all shipto customers, and their associated data, from a customer.

Retrieve all shipto customers associated with a customer.

 Associate a customer to another customer, as a ship to customer.

Unassociate a shipto state from a customer.

Need to pass in the shipto state id that you want to unassociate with your customer.

ship_to_states

Retrieve all shipto states, and their data, associated with a customer.

Retrieve all shipto states associated with a customer.

Associate a state to a customer as a ship to state.  NOTE: Adding and removing Ship-to States will automatically Add and Remove Exposure Zones associated with that State that have the auto_ship_to value set to true. 

Need to pass in the state name that you want to set as shipto state for your customer.

Retrieve all the exempt reasons for an account.

description

Designates if the Exempt Reason denotes a exposure.

denotes_exposure

Designates if the Exempt Reason denotes a exemption.

Action	HTTP Code
Valid request, processed synchronously	200 OK
Valid request where no content is expected	204 No Content
Resource no longer exists at that location	301 Moved Permanently
Request with missing required fields	400 Bad request
Request with invalid values	400 Bad request
Request without Auth header	401 Unauthorized
Request with incorrect Auth content/key	401 Unauthorized
Resource does not exist	404 Not Found
Invalid method sent to resource (e.g. PUT where only GET is permitted)	405 Method Not Allowed
Service is down	503 Service unavailable
Internal server error	503 Service unavailable