Certificate ordering

The AutoApplyOrder action initiates a new mark certificate order.

Endpoint: !AutoApplyOrder

https://secure.trust-provider.com/products/download/!AutoApplyOrder

The AutoApplyOrder API endpoint allows you to submit a new mark certificate order, including all required organization, domain, and trademark details. Use this endpoint to order the required product.

Use the POST method for this endpoint.

Submit parameters in the x-www-form-urlencoded format.

The following table lists the required and optional parameters.

Parameter Required/Optional Type Max. Length Description

loginName

required

string

64 chars

Your account username.

This value is case sensitive.

loginPassword

required

string

128 chars

Your account password.

This value is case sensitive.

product

required

string

64 chars

A comma-separated string of product codes for the product you are ordering.

The following product IDs are used:

Verified Mark Certificate (VMC): 801
Common Mark Certificate (CMC): 803

days

required

integer

Your requested product validity period in days.

The possible value is 365.

domainNames

required

string

32767 chars

A comma-separated list of domain names to be included in the resulting certificate.

dcvEmailAddresses

optional

string

32767 chars

A comma-separated list of DCV email addresses and/or DCV methods to be used for validating the domains specified in the domainNames parameter.

Each value in this list must correspond to the domain at the same position in the domainNames list. Supported DCV methods include email addresses (for example, [email protected]), HTTP_CSR_HASH, and CNAME_CSR_HASH. To validate a.com by email ([email protected]), b.com by HTTP_CSR_HASH, and c.com by CNAME_CSR_HASH, specify:

domainNames=a.com,b.com,c.com
dcvEmailAddresses=[email protected], HTTP_CSR_HASH, CNAME_CSR_HASH

csr

required

string

32767 chars

Your Base64 URL-encoded certificate signing request.

The CSR must not contain domain names other than those provided in the domainNames parameter value.

markLogo

required

string

32000 chars

Your Base64 URL-encoded trademark logo.

logoPriorUseDomainName

required

string

255 chars

(CMC only) The domain name where the logo has been previously used. This information serves as evidence of prior logo use.

For multi-domain CMC, this must be one of the domain names listed in the domainNames parameter.

trademarkCountryName

required

string

2 chars

(VMC only) The two-letter ISO country code where the trademark is registered.

trademarkOffice

required

string

128 chars

(VMC only) The trademark office where the trademark is registered.

trademarkIdentifier

required

string

64 chars

(VMC only) The trademark registration number or serial number.

organizationName

required

string

64 chars

The organization name requested for inclusion in the resulting certificate.

postOfficeBox

optional

string

40 chars

The organization post office box.

streetAddress1

required

string

128 chars

The street address of the organization provided for validation purposes.

streetAddress2

optional

string

128 chars

The second part of the organization’s street address (if necessary).

streetAddress3

optional

string

128 chars

The third part of the organization’s street address (if necessary).

localityName

required

string

128 chars

The city or town where the organization resides.

stateOrProvinceName

required

string

128 chars

The state or province in which the organization operates.

postalCode

required

string

40 chars

The postal code at which the organization operates.

countryName

required

string

2 chars

The country in which the organization operates.

companyNumber

required

string

64 chars

The registration number of the organization provided for validation purposes.

dunsNumber

optional

string

20 chars

A unique nine-digit identifier for businesses, provided by the company Dun & Bradstreet.

joiLocalityName

optional

string

128 chars

The city or locality where the organization is incorporated or registered.

joiStateOrProvinceName

optional

string

128 chars

The state or province where the organization is incorporated or registered.

joiCountryName

required

string

2 chars

The country where the organization is incorporated.

assumedName

optional

string

64 chars

An optional name under which the organization operates that is different from its legal name. This is a so-called DBA (doing business as) name for the company (if any).

dateOfIncorporation

optional

string

10 chars

The date when the organization was officially incorporated (YYYY-MM-DD).

businessCategory

required

char

1 char

The legal classification of the organization.

The possible values are:

b — Private
c — Government
d — Business Entity

appRepTitle

required

string

64 chars

The applicant representative’s job title.

appRepForename

required

string

64 chars

The applicant representative’s first name.

appRepSurname

required

string

64 chars

The applicant representative’s last name.

appRepEmailAddress

required

string

255 chars

The applicant representative’s email address.

appRepTelephone

required

string

32 chars

Applicant representative’s phone number.

appRepFax

optional

string

32 chars

The applicant representative’s fax number.

appRepOrganizationName

optional

string

64 chars

The applicant representative’s organization name.

appRepOrganizationalUnitName

optional

string

64 chars

The applicant representative’s organizational unit name.

appRepPostOfficeBox

optional

string

40 chars

The applicant representative’s post office box.

appRepStreetAddress1

optional

string

128 chars

The applicant representative’s street address.

appRepStreetAddress2

optional

string

128 chars

The second part of the applicant representative’s street address (if necessary).

appRepStreetAddress3

optional

string

128 chars

The third part of the applicant representative’s street address (if necessary).

appRepLocalityName

optional

string

128 chars

The applicant representative’s city or town.

appRepStateOrProvinceName

optional

string

128 chars

The applicant representative’s state or province.

appRepPostalCode

optional

string

40 chars

The applicant representative’s postal code.

appRepCountryName

optional

string

2 chars

The applicant representative’s country code.

signerTitle

optional

string

64 chars

The job title of the contract signer.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

This should be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerForename

optional

string

64 chars

The first name of the contract signer.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerSurname

optional

string

64 chars

The last name of the contract signer.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerEmailAddress

optional

string

255 chars

The email address of the contract signer.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerCountryName

optional

string

2 chars

The country in which the contract signer does business.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerTelephone

optional

string

32 chars

The contact phone number of the contract signer.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerPostOfficeBox

optional

string

40 chars

Signer’s post office box.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerStreetAddress1

optional

string

128 chars

The street address where the contract signer does business.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerStreetAddress2

optional

string

128 chars

The second part of the contract signer’s street address (if necessary).

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerStreetAddress3

optional

string

128 chars

The third part of the contract signer’s street address (if necessary).

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerLocalityName

optional

string

128 chars

The city in which the contract signer does business.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerStateOrProvinceName

optional

string

128 chars

The state or province in which the contract signer does business.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

signerPostalCode

optional

string

40 chars

The postal code at which the contract signer does business.

This parameter is optional and may be omitted if the Applicant Representative and the Signer are the same individual.

The signer must be a person with legal authority to accept the Subscriber Agreement on behalf of the organization named in the certificate.

logoHostedByCA

optional

string

1 char

Indicates whether the logo and certificates are hosted on the CA basis or not.

The possible options are:

Y - yes
N - no

If omitted, its value defaults to Y.

Sample request

curl --location --request POST 'https://secure.trust-provider.com/products/!AutoApplyOrder' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'product=100' \
--data-urlencode 'days=30' \
--data-urlencode 'isCustomerValidated=Y' \
--data-urlencode 'loginName=testuser' \
--data-urlencode 'loginPassword=TestPass123!' \
--data-urlencode 'domainNames=test.com,example.com' \
--data-urlencode '[email protected]' \
--data-urlencode '[email protected],[email protected]' \
--data-urlencode '[email protected]' \
--data-urlencode 'csr=-----BEGIN CERTIFICATE REQUEST-----TESTCSR-----END CERTIFICATE REQUEST-----' \
--data-urlencode 'markLogo=data:image/svg+xml;base64,TESTLOGODATA' \
--data-urlencode 'trademarkCountryName=US' \
--data-urlencode 'trademarkOffice=USPTO' \
--data-urlencode 'trademarkIdentifier=123456789' \
--data-urlencode 'organizationName=Test Org' \
--data-urlencode 'organizationalUnitName=IT' \
--data-urlencode 'postOfficeBox=123' \
--data-urlencode 'streetAddress1=1 Test St' \
--data-urlencode 'streetAddress2=Suite 2' \
--data-urlencode 'streetAddress3=Building 3' \
--data-urlencode 'localityName=Testville' \
--data-urlencode 'stateOrProvinceName=TestState' \
--data-urlencode 'postalCode=12345' \
--data-urlencode 'countryName=US' \
--data-urlencode 'mainTelephoneNumber=5551234567' \
--data-urlencode 'companyNumber=987654321' \
--data-urlencode 'dunsNumber=123456789' \
--data-urlencode 'joiLocalityName=Testville' \
--data-urlencode 'joiStateOrProvinceName=TestState' \
--data-urlencode 'joiCountryName=US' \
--data-urlencode 'assumedName=TestAssumed' \
--data-urlencode 'dateOfIncorporation=2020-01-01' \
--data-urlencode 'businessCategory=b' \
--data-urlencode 'signerTitle=Ms' \
--data-urlencode 'signerForename=Jane' \
--data-urlencode 'signerSurname=Doe' \
--data-urlencode '[email protected]' \
--data-urlencode 'signerCountryName=US' \
--data-urlencode 'signerTelephone=5559876543' \
--data-urlencode 'signerPostOfficeBox=456' \
--data-urlencode 'signerStreetAddress1=2 Signer St' \
--data-urlencode 'signerStreetAddress2=Suite 4' \
--data-urlencode 'signerStreetAddress3=Building 5' \
--data-urlencode 'signerLocalityName=Signerville' \
--data-urlencode 'signerStateOrProvinceName=SignerState' \
--data-urlencode 'signerPostalCode=54321' \
--data-urlencode 'appRepTitle=Prof' \
--data-urlencode 'appRepForename=Sam' \
--data-urlencode 'appRepSurname=Taylor' \
--data-urlencode 'appRepTelephone=5556667777' \
--data-urlencode 'appRepFax=5558889999' \
--data-urlencode 'appRepOrganizationName=AppRep Org' \
--data-urlencode 'appRepOrganizationalUnitName=Legal' \
--data-urlencode 'appRepPostOfficeBox=654' \
--data-urlencode 'appRepStreetAddress1=5 AppRep St' \
--data-urlencode 'appRepStreetAddress2=Suite 10' \
--data-urlencode 'appRepStreetAddress3=Building 11' \
--data-urlencode 'appRepLocalityName=AppRepville' \
--data-urlencode 'appRepStateOrProvinceName=AppRepState' \
--data-urlencode 'appRepPostalCode=11223' \
--data-urlencode 'appRepCountryName=US'

Success responses

Success response with code 0

0
1234567
// displayed price is for sample purposes only
110.00

Success response with code 1

errorCode=0&orderNumber=1234567&totalCost=100.00

Related information

Unsuccessful responses