Error Codes & Data Definition

<CertificateStatus>

The current status of a certificate.

1  INITIAL

2  Waiting for phishing check

3  Cancelled - Not Issued

4  Issue completed

6  Waiting for revocation

7  Revoked

Int

<CommonName>

The common name in certificate.

String/255

<CSRData>

  <CommonName>

  <Organization>

  <OrganizationUnit>

  <Locality>

  <State>

  <Country>

  <EmailAddress>

</CSRData>

Basic information on a certificate’s CSR.

<CSRSkipOrderFlag>

Boolean

<City>

Part of the Address structure.

String/200

<ContactInfo>                 <FirstName>             <LastName>              <Phone>     

      <Email>    

</ContactInfo>

Primary Contact Information of for a certificate request.

<Country>

Part of the Organization Address structure. The Country of the Organization. Must be a valid ISO country code.

String/2

<Coupon>

Coupons can be used for payment.

String/50

<CreditAgency>

The Organizations name.

1  DUNS No.

2  TDB code

String/50

<Currency>

The Currency of the transaction.

String/10

<CSR>

Certificate Signing Request. This is the Base64 encoded X.509 digital certificate signing request typically generated by the end user on their target web server. This is a critical element for all SSL orders.

String/4000

<DNSOrderFlag>

Boolean

<DNSNames>

Contains one or more DNSName values to be put into the certificate SubjectAltName extension. Each can be up to 64 characters. Values are comma delimited. Each DNSName may only contain alphanumeric values, plus dash and under bar – No periods.

String/300

<DomainName>

The domain name for an Order. For an SSL Order this can be a fully qualified Domain (e.g., www.globasign.com) or possibly a wildcard domain (e.g., *.globalsign.com.

String/255

<EndDate>

Expired date of certificate.

DateTime

<Email>

From the ContactInfo structure. The Email Address of the contact.

String/255

<Error>

      <ErrorCode>

      (<ErrorField>)?

      <ErrorMessage>

</Error>

A structure that contains an ErrorCode and an ErrorMessage. Error is part of the Errors structure.

<ErrorCode>

A unique code identifying the error.

Int

<ErrorField>

When there is a specific field that has caused the error, the XML tag for that field is placed in this structure. Where the tag is not unique in the entire message, one or more tags precede this so this field can be uniquely identified. For example, if the <Phone> field was invalid in the <AdminContact> structure, the return code would have <AdminContact><Phone>.

String/1000

<ErrorMessage>

A message describing an error in more detail. ErrorMessage is a part of the Error Structure.

String/1000

<Errors>

      (<Error>

      <ErrorCode>

      (<ErrorField>)?

      <ErrorMessage>

      </Error>)+

</Errors>

A list of the errors returned from a request. An Errors structure can have multiple Error elements. Errors is a part of the OrderResponseHeader structure. If present, this structure contains one or more errors.

<ErrorCode>

Int

<ErrorField>

String/1000

<ErrorMessage>

String/1000

(<ExpressOption>)?   

To add Express Options set to true. If not false.

Boolean

<Fax>

From the OrganizationAddress structure. The Fax number for the organization.

String/30

<FirstName>

From one of the Contact structures.  The First Name of the contact.

String/100

<FQDN>    

Fully Qualified Domain Name.

String/255

<FromDate>

The starting date used in various queries.

DateTime

<Fulfillment>

      <CACertificates>

      (<CACertificate>

            <CACertType>

            <CACert>

      </CACertificate>)+

      </CACertificates>?      (<ServerCertificate>

            <x509Cert>

            <PKCS7Cert>

    <ServerCertificate>)?

</Fulfillment>

Contains the CA certificate(s) and/or the ServerCertificate (in x509 and/or PKCS7 formats).

<Function>

Requestor job function.

String/255

<GSSupportOption>

To add GS Support set to true. If not false.

Boolean

<IncorporatingAgencyRegistrationNumber>                              

String/100

<InsuranceOption>

To add Insurance Options set to true. If not false.

Boolean

<IsValidDomainName>

Returns true if the domain name is valid for a certificate orders.

Boolean                  

<JurisdictionInfo>    

    < JurisdictionCountry>   

    (<StateOrProvince>)?   

    (<Locality>)?   

<IncorporatingAgencyRegistrationNumber>   

</JurisdictionInfo>    

Jurisdiction of Incorporation Details.

<KeyLength>

String/4

<LastName>

From one of the Contact structures.  The Last Name of the contact.

String/100

<Licenses>

This is the Number of Licenses.

Int

1-99 Only

<Locality>

The Locality field from the CSR or Certificate.

String/255

<ModificationEvent>

One event in the set of ModificationEvents.

<ModificationEventName>

The name of the event.

String/50

<ModificationEvents>

  (<ModificationEvent>

  <ModificationEventName>

  <ModificationEventTimestamp>

  </ModificationEvent>)+

</ModificationEvents>

The set of events for the order that caused the status to be changed within the specified time period. This is contained in OrderDetail. Used only in GetModifiedOrders.

<ModificationEventTimestamp>

The time of the event.

DateTime

<ModifyOrderOperation>

Specifies the operation to be performed on the order or certificate:

APPROVE

CANCEL

REVOKE

String/20

<Months>

The number of months that a certificate will be valid for.

Int/4

<NotAfter>

DateTime

<NotBefore>

DateTime

<OrderDate>

The date the order was created.

DateTime

<OrderDetail>

      <OrderInfo>

      (<OrderOption>)?

    (<CertificateInfo>)?

    (Fulfillment>?

      (<ModificationEvents>)?

</OrderDetail>

OrderDetail is returned in many Order Query operations. The specific content is dependent on the values in the request. ModificationEvents is only returned in GetModifiedOrders.

<OrderKind>

Type of order:

new: a new request

renewal: renewal of current certificate

transfer: a commercial upgrade of a current valid certificate.

String/10

<OrderID>

This is the OrderID assigned by GlobalSign to the order and provided to the person requesting the certificate.

String/50

<OrderInfo>

      <OrderID>

      <ProductCode>

      (<BaseOption>)?

      <OrderKind>

      <Licenses>

      (<ExpressOption>)?

(<ValidityPeriodCustomizeOption>)?

    (<InsuranceOption>)?

    (<GSSupportOption>)?

    (<RenewalExtentionOption>)?

      <DomainName>                        <OrderDate>

      (<OrderCompleteDate>)?

    (<OrderCanceledDate>)?

    (<OrderDeactivatedDate>)?

      <OrderStatus>    

    <Price>

      <Currency>

      <ValidityPeriod>

         <Months>

         (<NotBefore>)?

         (<NotAfter>)?

    </ValidityPeriod>

   (<SpecialInstructions>)?

</OrderInfo>

This structure contains basic information that applies to most orders and is profiled within each order response structure.

<OrderOption>

      <ApproverNotifiedDate>?

      <ApproverConfirmDate>?

      <ApproverEmailAddress>?

      <OrganizationInfo>

          <OrganizationName>

          (<CreditAgency>)?

          (<OrganizationCode>)?

          <OrganizationAddress>

              <AddressLine1>

              (<AddressLine2>)?

              (<AddressLine3>)?

              <City>

              <Region>

            <PostalCode>

              <Country>

            <Phone>

            (<Fax>)?

       </OrganizationAddress>

    </OrganizationInfo>

      (<ContactInfo>

       <FirstName>

       <LastName>

       <Phone>

       <Email>

    </ContactInfo>)?

</OrderOption>

This structure is in many order request messages and contains basic order information common to all types of orders.

<OrderParameter>             

    <ProductCode>

    (<BaseOption>)?    

    <OrderKind>  

    <Licenses>   

    (<ExpressOption>)?       

    (<ValidityPeriodCustomizeOption>)?

    (<InsuranceOption>)?

    (<GSSupportOption>)?

    (<RenewalExtentionOption>)?

    <ValidityPeriod>   

        <Months>

        (<NotBefore>)?

        (<NotAfter>)?

    </ValidityPeriod>  

    <CSR>

    (<RenewalTargetOrderID)?                  

    (<TargetCERT>)?

    (<DNSNames>)?                  

    (<SpecialInstructions>)?       

    (<Coupon>)?  

    (<Campaign>)?

</OrderParameter>

This structure is part of the order validation and order processes. It includes all details relating to the order and the CSR for parsing.

<OrderParameterWithoutCSR>    

    <ProductCode>   

    (<BaseOption>)?   

    <OrderKind>   

    <Licenses>   

    (<ExpressOption>)?

    (<ValidityPeriodCustomizeOption>)?  

    (<InsuranceOption>)?

    (<GSSupportOption>)?   

    (<RenewalExtentionOption>)?   

    <ValidityPeriod>   

        <Months>  

        (<NotBefore>)?  

        (<NotAfter>)?  

      </ValidityPeriod>

    <PIN>   

    <KeyLength>   

    (<RenewalTargetOrderID)?      

    (<TargetCERT>)?   

    (<DNSNames>)?   

    (<SpecialInstructions>)?   

    (<Coupon>)?   

    (<Campaign>)?  

</OrderParameterWithoutCSR>    

This structure is part of the order validation and order processes. It includes all details relating to the order without a CSR.

<OrderQueryOption>

      (<OrderStatus>?)      (<ReturnOrderOption>?) 

    (<ReturnCertificateInfo>?)

      (<ReturnFulfillment>?)

      (<ReturnCACerts>?)

</OrderQueryOption>

Specifies what is returned in the response message. All values default to false if not supplied so the corresponding data structure will not appear in the response.

<OrderRequestHeader>

      <AuthToken>

            <UserName>

            <Password>

      </AuthToken>

</OrderRequestHeader>

The OrderRequestHeader is used in all of the order operations.

<OrderResponseHeader>

      <SuccessCode>

      (<Errors>

            (<Error>

                  <ErrorCode>

           (<ErrorField>)?

                  <ErrorMessage>

            </Error>)+

      </Errors>)*

      <Timestamp>

</OrderResponseHeader>

This is the header returned in all Order operations.

<OrderStatus>

The current status of an Order:

1  INITIAL

2  Waiting for phishing check

3  Cancelled - Not Issued

4  Issue completed

5  Cancelled - Issued

6  Waiting for revocation

7  Revoked

Int

<OrderSubInfo>
 <CSRSkipOrderFlag>
 <DNSOrderFlag>
 <TrustedOrderFlag>
 <P12DeleteStatus>?
 <P12DeleteDate>?
 <VerificationUrl>?
 
</OrderSubInfo>

<Organization>

The Organization field from the certificate.

String/255

<OrganizationCode>

Can be used to indicate company numbers lookup e.g. For DUNS enter 1 in this field.

String/50

<OrganizationInfo>

      <OrganizationName>

    (<CreditAgency>)?

      (<OrganizationCode>)?

      <OrganizationAddress>

            <AddressLine1>

            (<AddressLine2>)?

            (<AddressLine3>)?

            <City>

            <Region>

            <PostalCode>

            <Country>

            <Phone>

            <Fax>?

      </OrganizationAddress>

</OrganizationInfo>

Organization Info sent with Certificate request.

<OrganizationInfoEV>     

    (<CreditAgency>)?   

    (<OrganizationCode>)?   

    (<BusinessAssumedName>)?   

    <BusinessCategoryCode>   

    <OrganizationAddress>    

    (<AddressLine1>)?

    (<AddressLine2>)?  

    (<AddressLine3>)?  

    <City>  

    <Region>  

    <PostalCode>  

    <Country>  

    <Phone>  

    (<Fax>)?  

    </OrganizationAddress>   

</OrganizationInfoEV>

Organization Info sent with Certificate request.

<OrganizationName>

The name of the Organization applying for a certificate.

String/255

<OrganizationUnit>

The OrganizationalUnit name from the CSR.

String/255

<OVCSRInfo>     

    <OrganizationName>   

    (<OrganizationUnit>)?   

    <Locality>   

    <StateOrProvince>   

    <Country>   

 </OVCSRInfo>

Info to be used in the creation of the Certificate.

(<ParsedCSR>

   <DomainName>

   <Country>

   <Email>

   <Locality>

   <Organization>

   <OrganizationUnit>

   <State>

   <IsValidDomainName>

</ParsedCSR>)?

Details from the CSR.

<Password>

Required for user authentication over the API.

String/30

<Phone>

From one of the Contact or OrganizationAddress structures.

String/30

<P12DeleteDate>

DateTime

<P12DeleteStatus>

Int

<PKCS12File>

A bese64-encoded PKCS#12

String/4000

<PKCS7Cert>

A Base64-encoded PKCS#7

String/20000

<PostalCode>

From the Address structure. The Postal Code (e.g., Zip Code in the U.S.) for the Address.

String/20

<ProductCode>

A code for the product that a particular request relates to. Note that a partner must have a valid contract for a product code for it to be valid in a request. Also, a product code must be valid for the context of the request.

String/20

<QueryRequestHeader>

      <AuthToken>

            <UserName>

            <Password>

      </AuthToken>

</QueryRequestHeader>

The header on all Query Request operations.

<QueryResponseHeader>
 <Errors>?
 <ReturnCount>
 <SuccessCode>
 <Timestamp>
</OrderResponseHeader>

<Region>

Region, state/prov

From the Address structure. This is the region of the address such as state or province. If this is a U.S. state it must have a valid 2 character abbreviation.

String/255

<RenewalExtentionOption>>

To add bonus to validity period set to true. If not false.

Boolean

<ReOrderParameter>
 <CSR>
 <DNSNames>?
</ReOrderParameter>

<ReOrderParameterWithoutCSR>
 <DNSNames>?
 <PIN>
 <KeyLength>
</ReOrderParameterWithoutCSR>

<RenewalTargetOrderID>

Original OrderID for renewal orders.

String/50

<RequestorInfo>    

    <FirstName>   

    <LastName>   

    (<Function>)?   

    <OrganizationName>   

    (<OrganizationUnit>)?   

    <Phone>   

    <Email>   

</RequestorInfo>

A Certificate Requester is a natural person who is Applicant, employed by Applicant, or an authorized agent who has express authority to represent Applicant or a third party (such as an ISP or hosting company) that completes and submits a Certificate Request on behalf of Applicant.

<ResendEmailType>

Current values are:

ApproverEmail – resend the approver email for any QuickSSL order.

String/20

<ReturnCACerts>

If set to true in the request message, the CACerts structure is populated in the Fulfillment structure of the response message.

Boolean

<ReturnCertificateInfo>

If set to true in the request message, the CertificateInfo structure appears in the response message.

Boolean

<ReturnCount>

The number of items returned in the message.

Int

<ReturnFulfillment>

If set to true in the request message, the Fulfillment structure appears in the response message.

Boolean

<ReturnOrderOption>

In the response, product information will be in details if set to true.

Boolean

<SearchOrderDetail>
 <OrderID>
 <BaseOption>?
 <OrderKind>
 <RequestKind>
 <Licenses>
 <OrderRequestDate>
 <OrderIssueDate>?
 <OrderCanceledDate>?
 <OrderStatus>
 <OrganizationName>
 <Months>
 
 <FQDN>
</SearchOrderDetail>

<SecondContactInfo>

Secondary contact for this order.

<SerialNumber>

The serial number of a certificate specified as a hex string.

String/64

<ServerCertificate>
 <X509Cert>
 <PKCS7Cert>
</ServerCertificate>

<SpecialInstructions>

Special Instructions for the order.

String/4000

<StartDate>

Start date of certificate.

DateTime

<State>

The value of the State in the ParseCSRResponse.

String/255

<StateOrProvince>

String/255

<SubjectName>

The SubjectName in certificate.

String/255

<SuccessCode>

Code in the Order and Query Response Headers which indicates the success or failure of the request:

A zero SuccessCode indicates a success with no warnings.

A positive SuccessCode indicates a success with warnings.

A negative SuccessCode indicates a failure.

Note that if the Success in non-zero an accompanying Errors structure will be present.

Int

<TargetCERT>

The base64-encoded certificate you are transferring from.

String/4000

<TargetOrderID>

String/50

<Timestamp>

A date timestamp used in a variety of contexts. Note that the XML format is: YYYY-MM-DDTHH:MM:SS.000Z (for example, 2001-01-01T24:00:00:000Z is for Jan 1, 2001 at midnight).

DateTime

<TrustedOrderFlag>

Boolean

<UserName>

Required for user authentication.

String/30

<ValidityPeriod>

    <Months>

    (<NotBefore>)?

    (<NotAfter>)?

</ValidityPeriod>

The number of months that a certificate or site seal will be valid for. Please set it to 12.

<ValidityPeriodCustomizeOption>

To customize the validity period set to true. If not false.

Boolean

<VerificationUrl>    

An allowable URL which the metatag for URLVerification can occur on.

String/300

<VerificationFQDN>    

An allowable FQDN which the DNS txt record for DNS Verification can occur on.

String/300

<MarkInfo>

<SvgLogoBase64>

               <MarkLicenseExpiryDate>                     YYYY-MM-DD

               <TrademarkIdentifier>

               <TrademarkCountryOrRegionName>

               <TrademarkOfficeName>

<StatuteCitation>

               <StatuteLocalityName>

               <StatuteStateOrProvinceName>

               <StatuteCountryName>

               <PriorUseMarkSourceURL>

               <DnAttributes>

                  <CommonNameSAN>

                  <Organization>

                  <Locality>

                        <StateOrProvince>

                  <Country>

               </DnAttributes>

            </MarkInfo>

This structure is a part of Mark Certificates request

For understanding the values that needs to be provided to these tags please read the explanations below: Also Example Sample requests are provided in Section 4.1.1 onwards.

<SvgLogoBase64> - For all mark types

Please provide the base64 file of the SVG you want to use in your certificate.

<MarkLicenseExpiryDate> - For VMC and MMC only

YYYY-MM-DD

Please input the date of the license expiry of your Trademark. 
If you are not sure, then please leave this blank. Our vetting team will find this out for you. 

<TrademarkIdentifier> - For VMC and MMC only

Please enter the trademark license identifier/unique  license number.

<TrademarkCountryOrRegionName> - For VMC and MMC only

Enter the Two Digit Country code.

<TrademarkOfficeName> - For VMC and MMC only

Select the trademark office  where your trademark logo is  registered.

<StatuteCitation> - For GMC only

If you have some reference link that you can provide for the reference that can help us identify the legal status of the logo being used i.e. some legal statue reference or article. If not sure, leave it blank.

<StatuteLocalityName> - For GMC only

Enter the locality name

<StatuteStateOrProvinceName> - For GMC only

Enter the state or province name

<StatuteCountryName> - For GMC only

Enter the country name

<PriorUseMarkSourceURL> - For CMC only.

If you are sure of the archive URL of the logo display from past 12 months then please enter it here.

<CommonNameSAN> - For alL Mark Type

Please enter your domain name like example.com

<Organization>

Enter the organization name.

<Locality>

Enter the locality name

<Country>

Enter the country name

<Request>

              <QueryRequestHeader>

                      <AuthToken>

                             <UserName>                   30     String

                             <Password>                   30     String

                      </AuthToken>

              </QueryRequestHeader>

              <SvgLogoBase64>                                    String                      

       </Request >

This structure is the part of the validate logo request. You can use this to check any problem or issues with your provided SVG File.

Under <SvgLogoBase64>

Please provide the SVG file in Base64 format only.

<X509Cert>

A base64-encoded certificate.

String/4000