Signup API API documentation version 1.1 br>
** DEPRECATED ** - Please use our new SAPI version here
https://{environment}/api/signup
/start
Entry point to Signup API that returns a trackingToken which the majority of other API calls require. The start resource is meant to be called just once per enrollment and the returned trackingToken should be saved for subsequent calls.
get
get /start
Query Parameters
- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- PID: (string - default: organic PID)
Unique publisher ID provided by Consumer Direct.
Example:
12345
- AID: (string - maxLength: 50)
Your marketing affiliate or partner ID.
Example:
1662780
- ADID: (string - maxLength: 255)
Your marketing ad creative ID.
Example:
5000
- CID: (string - maxLength: 255)
Your marketing campagin ID.
Example:
ABR:DBL_OD_WOULDYOULIKETOADD_041615
- channel: (one of paid)
Your marketing channel.
Example:
paid
HTTP status code 200
Successful response that provides a tracking token used for subsequent API interactions.
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"trackingToken": {
"type": "string"
}
},
"required": [
"trackingToken"
]
}
Example:
{
"trackingToken": "53679db0-093e-11e5-b939-0800200c9a66"
}
HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}/complete
Final validation on a registrant record and performs transition to being a full member.
post
post /complete
Body
Type: application/x-www-form-urlencoded
Form Parameters- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- customerToken: required (string - maxLength: 36)
A unique identifier assigned to a customer account upon its creation that is used to reference that customer through the sign up process.
Example:
7307cecc-274d-4b96-b871-519ae2699c41
HTTP status code 200
A successful response that provides a temporary password that can be used to help auto login the customer.
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"planType": {
"enum": [
"FREE",
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP",
"BUNDLE"
]
},
"temporaryPassword": {
"type": "string"
}
},
"required": [
"planType",
"temporaryPassword"
]
}
Example:
{
"planType": "PREMIUM",
"temporaryPassword": "0000000002DZVLH+q62g+y3CwcEUySVMMCOifmI04CWSWurcdHDUA="
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "FINANCIAL_OBLIGATION_INVALID",
"message": "Financial obligation must be met to complete customer sign up"
},
{
"code": "TERMS_NOT_CONFIRMED",
"message": "You must confirm the Terms and Conditions",
"field": "isConfirmedTerms",
"value": "false"
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}/id-verification
ID verification to ensure customer is actually who they say they are. Required before a credit report and score can be delivered.
get
Fetch a set of ID verification questions for the customer to answer.
post
Provide answers to the ID verification questions. In the case of an answer failure here a new question set and reference number must be obtained to try again.
get /id-verification
Fetch a set of ID verification questions for the customer to answer.
Query Parameters
- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- customerToken: required (string - maxLength: 36)
A unique identifier assigned to a customer account upon its creation that is used to reference that customer through the sign up process.
Example:
7307cecc-274d-4b96-b871-519ae2699c41
HTTP status code 200
A successful response that provides referenceNumber to be used with the /id-verification POST call.
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"idVerificationCriteria": {
"id": "http://jsonschema.net/idVerificationCriteria",
"type": "object",
"properties": {
"referenceNumber": {
"id": "http://jsonschema.net/idVerificationCriteria/referenceNumber",
"type": "string"
},
"question1": {
"id": "http://jsonschema.net/idVerificationCriteria/question1",
"type": "object",
"properties": {
"name": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/name",
"type": "string"
},
"displayName": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/displayName",
"type": "string"
},
"type": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/type",
"type": "string"
},
"choiceList": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList",
"type": "object",
"properties": {
"choice": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/0",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/0/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/0/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/1",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/1/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/1/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/2",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/2/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/2/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/3",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/3/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/3/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/4",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/4/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question1/choiceList/choice/4/display",
"type": "string"
}
}
}
]
}
}
}
}
},
"question2": {
"id": "http://jsonschema.net/idVerificationCriteria/question2",
"type": "object",
"properties": {
"name": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/name",
"type": "string"
},
"displayName": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/displayName",
"type": "string"
},
"type": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/type",
"type": "string"
},
"choiceList": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList",
"type": "object",
"properties": {
"choice": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/0",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/0/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/0/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/1",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/1/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/1/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/2",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/2/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/2/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/3",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/3/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/3/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/4",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/4/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question2/choiceList/choice/4/display",
"type": "string"
}
}
}
]
}
}
}
}
},
"question3": {
"id": "http://jsonschema.net/idVerificationCriteria/question3",
"type": "object",
"properties": {
"name": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/name",
"type": "string"
},
"displayName": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/displayName",
"type": "string"
},
"type": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/type",
"type": "string"
},
"choiceList": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList",
"type": "object",
"properties": {
"choice": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/0",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/0/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/0/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/1",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/1/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/1/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/2",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/2/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/2/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/3",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/3/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/3/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/4",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/4/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question3/choiceList/choice/4/display",
"type": "string"
}
}
}
]
}
}
}
}
},
"question4": {
"id": "http://jsonschema.net/idVerificationCriteria/question4",
"type": "object",
"properties": {
"name": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/name",
"type": "string"
},
"displayName": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/displayName",
"type": "string"
},
"type": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/type",
"type": "string"
},
"choiceList": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList",
"type": "object",
"properties": {
"choice": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/0",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/0/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/0/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/1",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/1/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/1/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/2",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/2/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/2/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/3",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/3/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/3/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/4",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/4/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question4/choiceList/choice/4/display",
"type": "string"
}
}
}
]
}
}
}
}
},
"question5": {
"id": "http://jsonschema.net/idVerificationCriteria/question5",
"type": "object",
"properties": {
"name": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/name",
"type": "string"
},
"displayName": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/displayName",
"type": "string"
},
"type": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/type",
"type": "string"
},
"choiceList": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList",
"type": "object",
"properties": {
"choice": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/0",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/0/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/0/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/1",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/1/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/1/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/2",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/2/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/2/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/3",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/3/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/3/display",
"type": "string"
}
}
},
{
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/4",
"type": "object",
"properties": {
"key": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/4/key",
"type": "string"
},
"display": {
"id": "http://jsonschema.net/idVerificationCriteria/question5/choiceList/choice/4/display",
"type": "string"
}
}
}
]
}
}
}
}
}
},
"required": [
"referenceNumber",
"question1"
]
}
},
"required": [
"idVerificationCriteria"
]
}Example:
{
"idVerificationCriteria": {
"referenceNumber": "07271524018421870957",
"question1": {
"name": "YEAR_FOUNDED",
"displayName": "What year was ConsumerDirect® (aka PathwayData, aka MyPerfectCredit) founded?",
"type": "MC",
"choiceList": {
"choice": [
{
"key": "1980",
"display": "1980"
},
{
"key": "1969",
"display": "1969"
},
{
"key": "2012",
"display": "2012"
},
{
"key": "2003",
"display": "2003"
},
{
"key": "!(1980^1969^2012^2003)",
"display": "None of the above"
}
]
}
},
"question2": {
"name": "NOT_CREDIT_BUREAU",
"displayName": "Which company is NOT a credit bureau?",
"type": "MC",
"choiceList": {
"choice": [
{
"key": "Experian",
"display": "Experian"
},
{
"key": "ConsumerDirect",
"display": "ConsumerDirect"
},
{
"key": "Equifax",
"display": "Equifax"
},
{
"key": "TransUnion",
"display": "TransUnion"
},
{
"key": "!(Experian^ConsumerDirect^Equifax^TransUnion^)",
"display": "None of the above"
}
]
}
},
"question3": {
"name": "INVENTED_INTERNET",
"displayName": "Who invented the internet?",
"type": "MC",
"choiceList": {
"choice": [
{
"key": "J. C. R. Licklider",
"display": "J. C. R. Licklider"
},
{
"key": "George Clooney",
"display": "George Clooney"
},
{
"key": "Al Gore",
"display": "Al Gore"
},
{
"key": "Howard Stark",
"display": "Howard Stark"
},
{
"key": "!(J. C. R. Licklider^George Clooney^Al Gore^Howard Stark^)",
"display": "None of the above"
}
]
}
}
}
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "FETCH_QUESTION_ERROR",
"message": "Could not present questions, customer needs to check their name/address/ssn/birthday."
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}post /id-verification
Provide answers to the ID verification questions. In the case of an answer failure here a new question set and reference number must be obtained to try again.
Body
Type: application/x-www-form-urlencoded
Form Parameters- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- customerToken: required (string - maxLength: 36)
A unique identifier assigned to a customer account upon its creation that is used to reference that customer through the sign up process.
Example:
7307cecc-274d-4b96-b871-519ae2699c41
- idVerificationCriteria.referenceNumber: required (string - maxLength: 63)
Question set identifier provided with questions. Must be passed back with to associate answers with questions. A reference number belongs to only one particular question set and answers to those questions can only be submitted once.
Example:
07271524018421870957
- idVerificationCriteria.answer1: required (string)
The answer to question 1. This is the idVerificationCriteria.question1.choiceList.choice.key value from the GET request.
Example:
2003
- idVerificationCriteria.answer2: (string)
The answer to question 2. This is the idVerificationCriteria.question2.choiceList.choice.key value from the GET request. Required if question 2 was provided.
Example:
ConsumerDirect®
- idVerificationCriteria.answer3: (string)
The answer to question 3. This is the idVerificationCriteria.question3.choiceList.choice.key value from the GET request. Required if question 3 was provided.
Example:
J. C. R. Licklider
- idVerificationCriteria.answer4: (string)
The answer to question 4. This is the idVerificationCriteria.question4.choiceList.choice.key value from the GET request. Required if question 4 was provided.
Example:
123 Main
- idVerificationCriteria.answer5: (string)
The answer to question 5. This is the idVerificationCriteria.question5.choiceList.choice.key value from the GET request. Required if question 5 was provided.
Example:
$450,000
HTTP status code 200
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {}
}
Example:
{}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "FAILED",
"message": "Sorry, we were unable to verify your identity based on your answers. Please check your information and try again."
},
{
"code": "ID_VERIFICATION_REFERENCE_NUMBER_INVALID",
"message": "The ID verification reference number is invalid. No questions found or a new set is required."
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}/campaign
Details relating to a PID (campaign). This can include cobrand details if applicable, member plan details, and support details such as a support phone number and hours.
get
get /campaign
Query Parameters
- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- PID: (string)
Unique publisher ID provided by Consumer Direct. If none is provided the default PID for the product will be used. Whatever PID is used to pull up the campaign details will be returned.
Example:
12345
HTTP status code 200
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://example.com/root.json",
"type": "object",
"title": "The Root Schema",
"required": [
"PID",
"memberPlans",
"model"
],
"properties": {
"PID": {
"$id": "#/properties/PID",
"type": "string"
},
"cobrand": {
"$id": "#/properties/cobrand",
"type": "object",
"required": [
"appIconUrl",
"company",
"description",
"description2",
"logoUrl",
"title",
"title2",
"websiteUrl"
],
"properties": {
"appIconUrl": {
"$id": "#/properties/cobrand/properties/appIconUrl",
"type": "string"
},
"company": {
"$id": "#/properties/cobrand/properties/company",
"type": "string"
},
"description": {
"$id": "#/properties/cobrand/properties/description",
"type": "string"
},
"description2": {
"$id": "#/properties/cobrand/properties/description2",
"type": "string"
},
"logoUrl": {
"$id": "#/properties/cobrand/properties/logoUrl",
"type": "string"
},
"title": {
"$id": "#/properties/cobrand/properties/title",
"type": "string"
},
"title2": {
"$id": "#/properties/cobrand/properties/title2",
"type": "string"
},
"websiteUrl": {
"$id": "#/properties/cobrand/properties/websiteUrl",
"type": "string"
}
}
},
"memberPlans": {
"$id": "#/properties/memberPlans",
"type": "object",
"required": [
"authMode",
"marketingText",
"signupPlanTypes",
"signupPlans"
],
"properties": {
"authMode": {
"$id": "#/properties/memberPlans/properties/authMode",
"enum": [
"NO_AUTH",
"AUTH_DECISION",
"AUTH_NO_DECISION",
"AUTH_CAPTURE",
"VERIFICATION"
]
},
"marketingText": {
"$id": "#/properties/memberPlans/properties/marketingText",
"type": "string"
},
"signupPlanTypes": {
"$id": "#/properties/memberPlans/properties/signupPlanTypes",
"type": "array",
"description": "The membership plan types the customer is allowed to signup under. Most can simply be returned as a choice but some like SPONSORED have further requirements like providing a valid sponsor code.",
"items": {
"$id": "#/properties/memberPlans/properties/signupPlanTypes/items",
"enum": [
"FREE",
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP",
"BUNDLE"
]
}
},
"signupPlans": {
"$id": "#/properties/memberPlans/properties/signupPlans",
"type": "array",
"title": "The Signupplans Schema",
"items": {
"$id": "#/properties/memberPlans/properties/signupPlans/items",
"type": "object",
"title": "The Items Schema",
"required": [
"bundle",
"charge3B",
"chargeDisplay",
"chargeMonthly",
"chargeSetup",
"hasAction",
"hasInstantAction",
"hasMoneyManager",
"hasCreditMonitoring",
"hasIdFraudInsurance",
"hasScoreBuilder",
"hasScoreMaster",
"hasScoreMasterOffers",
"hasScoreMasterSharing",
"hasActivityMonitoring",
"hasCreditReport",
"hasCreditReportAutoPull",
"has3B",
"hasSignup3BAutoPull",
"hasAccountVerification",
"hasIdVerification",
"hasPrivacyMaster",
"has3BAction",
"included3BReportsPerMonth",
"isTrial",
"maxActionsPerMonth",
"maxCreditReportsPerMonth",
"memberPlanId",
"name",
"offerType",
"planType",
"premium",
"trialLength"
],
"properties": {
"bundle": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/bundle",
"type": "boolean"
},
"charge3B": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/charge3B",
"type": "number"
},
"chargeDisplay": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/chargeDisplay",
"type": "number"
},
"chargeMonthly": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/chargeMonthly",
"type": "number"
},
"chargeSetup": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/chargeSetup",
"type": "integer"
},
"hasAction": {
"type": "boolean"
},
"hasInstantAction": {
"type": "boolean"
},
"hasMoneyManager": {
"type": "boolean"
},
"hasCreditMonitoring": {
"type": "boolean"
},
"hasIdFraudInsurance": {
"type": "boolean"
},
"hasScoreBuilder": {
"type": "boolean"
},
"hasScoreMaster": {
"type": "boolean"
},
"hasScoreMasterOffers": {
"type": "boolean"
},
"hasScoreMasterSharing": {
"type": "boolean"
},
"hasActivityMonitoring": {
"type": "boolean"
},
"hasCreditReport": {
"type": "boolean"
},
"hasCreditReportAutoPull": {
"type": "boolean"
},
"has3B": {
"type": "boolean"
},
"hasSignup3BAutoPull": {
"type": "boolean"
},
"hasAccountVerification": {
"type": "boolean"
},
"hasIdVerification": {
"type": "boolean"
},
"hasPrivacyMaster": {
"type": "boolean"
},
"has3BAction": {
"type": "boolean"
},
"included3BReportsPerMonth": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/included3BReportsPerMonth",
"type": "integer"
},
"isTrial": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/isTrial",
"type": "boolean"
},
"maxActionsPerMonth": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/maxActionsPerMonth",
"type": "integer"
},
"maxCreditReportsPerMonth": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/maxCreditReportsPerMonth",
"type": "integer"
},
"memberPlanId": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/memberPlanId",
"type": "integer"
},
"name": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/name",
"type": "string"
},
"offerType": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/offerType",
"enum": [
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP"
]
},
"planType": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/planType",
"enum": [
"FREE",
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP",
"BUNDLE"
]
},
"premium": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/premium",
"type": "boolean",
"default": false
},
"trialLength": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/trialLength",
"type": "integer",
"default": 0
},
"nextPlan": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan",
"type": "object",
"description": "This sub-plan is included if the parent planType is BUNDLE. This is the plan the customer will move to once the bundle plan reaches it's end.",
"required": [
"memberPlanId",
"name",
"offerType",
"planType",
"chargeMonthly",
"chargeSetup",
"charge3B",
"maxCreditReportsPerMonth",
"included3BReportsPerMonth",
"maxActionsPerMonth",
"premium",
"bundle",
"hasAction",
"hasInstantAction",
"hasMoneyManager",
"hasCreditMonitoring",
"hasIdFraudInsurance",
"hasScoreBuilder",
"hasScoreMaster",
"hasScoreMasterOffers",
"hasScoreMasterSharing",
"hasActivityMonitoring",
"hasCreditReport",
"hasCreditReportAutoPull",
"has3B",
"hasSignup3BAutoPull",
"hasAccountVerification",
"hasIdVerification",
"hasPrivacyMaster",
"has3BAction",
"isTrial",
"trialLength",
"chargeDisplay"
],
"properties": {
"memberPlanId": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/memberPlanId",
"type": "integer"
},
"name": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/name",
"type": "string"
},
"offerType": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/offerType",
"enum": [
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP"
]
},
"planType": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/planType",
"enum": [
"FREE",
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP",
"BUNDLE"
]
},
"chargeMonthly": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/chargeMonthly",
"type": "number"
},
"chargeSetup": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/chargeSetup",
"type": "integer"
},
"charge3B": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/charge3B",
"type": "number"
},
"maxCreditReportsPerMonth": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/maxCreditReportsPerMonth",
"type": "integer"
},
"included3BReportsPerMonth": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/included3BReportsPerMonth",
"type": "integer"
},
"maxActionsPerMonth": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/maxActionsPerMonth",
"type": "integer"
},
"premium": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/premium",
"type": "boolean"
},
"bundle": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/bundle",
"type": "boolean"
},
"hasAction": {
"type": "boolean"
},
"hasInstantAction": {
"type": "boolean"
},
"hasMoneyManager": {
"type": "boolean"
},
"hasCreditMonitoring": {
"type": "boolean"
},
"hasIdFraudInsurance": {
"type": "boolean"
},
"hasScoreBuilder": {
"type": "boolean"
},
"hasScoreMaster": {
"type": "boolean"
},
"hasScoreMasterOffers": {
"type": "boolean"
},
"hasScoreMasterSharing": {
"type": "boolean"
},
"hasActivityMonitoring": {
"type": "boolean"
},
"hasCreditReport": {
"type": "boolean"
},
"hasCreditReportAutoPull": {
"type": "boolean"
},
"has3B": {
"type": "boolean"
},
"hasSignup3BAutoPull": {
"type": "boolean"
},
"hasAccountVerification": {
"type": "boolean"
},
"hasIdVerification": {
"type": "boolean"
},
"hasPrivacyMaster": {
"type": "boolean"
},
"has3BAction": {
"type": "boolean"
},
"isTrial": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/isTrial",
"type": "boolean"
},
"trialLength": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/trialLength",
"type": "integer"
},
"chargeDisplay": {
"$id": "#/properties/memberPlans/properties/signupPlans/items/properties/nextPlan/properties/chargeDisplay",
"type": "number"
}
}
}
}
}
}
}
},
"partnerType": {
"$id": "#/properties/partnerType",
"type": "string",
"description": "This is dependent on the contract type you have with ConsumerDirect®"
},
"model": {
"$id": "#/properties/model",
"type": "object",
"title": "The Model Schema",
"required": [
"supportHours",
"supportPhoneNumber"
],
"properties": {
"supportHours": {
"$id": "#/properties/model/properties/supportHours",
"type": "string"
},
"supportPhoneNumber": {
"$id": "#/properties/model/properties/supportPhoneNumber",
"type": "string"
}
}
}
}
}
Example:
{
"PID": "12345",
"cobrand": {
"appIconUrl": "https://edgecastcdn.net/000E71/live/cobrand/11008/app-icon-3cv7ads2.png",
"company": "Your Biz",
"description": "Customized special messaging ",
"description2": "We give you the best tools to manage your financial weatlh. We support you along the way. ",
"logoUrl": "https://edgecastcdn.net/000E71/live/cobrand/11008/logo-6x2ku8jj.png",
"title": "Company Name Here",
"title2": "Company Sub-Title",
"websiteUrl": "https://www.smartcredit.com/?PID=11008"
},
"memberPlans": {
"authMode": "AUTH_NO_DECISION",
"marketingText": "7 Day Trial!",
"signupPlanTypes": [
"PREMIUM",
"BASIC"
],
"signupPlans": [
{
"bundle": false,
"charge3B": 29.95,
"chargeDisplay": 19.95,
"chargeMonthly": 19.95,
"chargeSetup": 1.0,
"hasAction": true,
"hasCreditMonitoring": true,
"hasIdFraudInsurance": true,
"hasInstantAction": true,
"hasMoneyManager": true,
"hasScoreBuilder": true,
"hasScoreMaster": true,
"hasScoreMasterOffers": false,
"hasScoreMasterSharing": false,
"hasActivityMonitoring": false,
"hasCreditReport": true,
"hasCreditReportAutoPull": false,
"has3B": true,
"hasSignup3BAutoPull": false,
"hasAccountVerification": true,
"hasIdVerification": true,
"hasPrivacyMaster": true,
"has3BAction": false,
"included3BReportsPerMonth": 0,
"isTrial": true,
"maxActionsPerMonth": 20,
"maxCreditReportsPerMonth": 4,
"memberPlanId": 1060,
"name": "Premium",
"offerType": "PREMIUM",
"planType": "PREMIUM",
"premium": true,
"trialLength": 7
},
{
"bundle": false,
"charge3B": 29.95,
"chargeDisplay": 14.95,
"chargeMonthly": 14.95,
"chargeSetup": 1.0,
"hasAction": true,
"hasCreditMonitoring": true,
"hasIdFraudInsurance": true,
"hasInstantAction": false,
"hasMoneyManager": true,
"hasScoreBuilder": true,
"hasScoreMaster": true,
"hasScoreMasterOffers": false,
"hasScoreMasterSharing": false,
"hasActivityMonitoring": false,
"hasCreditReport": true,
"hasCreditReportAutoPull": false,
"has3B": true,
"hasSignup3BAutoPull": false,
"hasAccountVerification": true,
"hasIdVerification": true,
"hasPrivacyMaster": true,
"has3BAction": false,
"included3BReportsPerMonth": 0,
"isTrial": true,
"maxActionsPerMonth": 5,
"maxCreditReportsPerMonth": 2,
"memberPlanId": 868,
"name": "Basic",
"offerType": "BASIC",
"planType": "BASIC",
"premium": false,
"trialLength": 7
}
]
},
"partnerType": "COBRAND",
"model": {
"supportHours": "Monday - Friday 10AM - 8PM Eastern",
"supportPhoneNumber": "(877) 372-3895"
}
}
HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "PID_INVALID",
"message": "Please supply a valid PID",
"field": "PID",
"value": "12345"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}/security-questions
Security questions the customer can choose from to further secure their account.
get
get /security-questions
Query Parameters
- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
HTTP status code 200
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"securityQuestions": {
"id": "http://jsonschema.net/securityQuestions",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/securityQuestions/0",
"type": "object",
"properties": {
"securityQuestionId": {
"id": "http://jsonschema.net/securityQuestions/0/securityQuestionId",
"type": "integer"
},
"question": {
"id": "http://jsonschema.net/securityQuestions/0/question",
"type": "string"
}
},
"required": [
"securityQuestionId",
"question"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"securityQuestions"
]
}Example:
{
"securityQuestions": [
{
"securityQuestionId": 1,
"question": "What was your high school mascot?"
},
{
"securityQuestionId": 2,
"question": "What was your first grade teacher's last name?"
},
{
"securityQuestionId": 3,
"question": "What was the make and model of your first car?"
},
{
"securityQuestionId": 4,
"question": "What is your mother's middle name?"
},
{
"securityQuestionId": 5,
"question": "What is your father's middle name?"
},
{
"securityQuestionId": 6,
"question": "What city were you born in?"
},
{
"securityQuestionId": 7,
"question": "What is your grandmother's first name (on your mother's side)?"
},
{
"securityQuestionId": 8,
"question": "What is your grandfather's first name (on your father's side)?"
}
]
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}/validate
Validation routine that ensures email is valid and not tied to an existing account.
get
get /validate/email
Query Parameters
- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- email: required (string - maxLength: 100 - pattern: ^(?=[0-9A-Za-z@.\\-_+]*$).*)
Customer's email address that will be used for logging in and product communication.
Example:
john@email.com
HTTP status code 200
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {}
}
Example:
{}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "EMAIL_USED",
"message": "Email exists, please choose another email"
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}Validation routine that ensures sponsor code is valid. Only applicable for campaigns that have a cobrand and sponsor code(s).
get
get /validate/sponsor-code
Query Parameters
- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- sponsorCode: required (string - maxLength: 36)
Unique code associated with a Cobrand that will direct membership costs to the cobrand partner rather than customer.
Example:
AWESOMECREDITNOW
HTTP status code 200
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"PID": {
"type": "string",
"description": "Consumer Direct's unique publisher ID that is behind the sponsor code that was submitted"
}
}
}
Example:
{
"PID": "12345"
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "SPONSOR_CODE_INVALID",
"message": "The sponsor code provided is invalid, please verify your code"
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}Validation routine that ensures social security is valid and doesn't already belong to an existing customer.
get
get /validate/ssn
Query Parameters
- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- customerToken: (string - maxLength: 36)
A unique identifier assigned to a customer account upon its creation that can be used to reference that customer through the sign up process. Required if checking SSN validity of an existing registrant account in the ConsumerDirect system. This will be the typical usecase.
Example:
7307cecc-274d-4b96-b871-519ae2699c41
- ssn: required (string - minLength: 9 - maxLength: 11)
Customer's social security number. Can include dashes or not.
Example:
666-24-1234
HTTP status code 200
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {}
}
Example:
{}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "SSN_USED",
"message": "A customer exists with the SSN you entered."
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}Validation routine that checks credit card number and when valid returns a unique token that should be used in place of the number in all subsequent transactions. This includes check that credit card number hasn't already been registered more than once with a member.
get
get /validate/credit-card-number
Query Parameters
- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- number: required (string - minLength: 15 - maxLength: 16)
Plain text credit card number.
Example:
4012888888881881
HTTP status code 200
A successful response that returns a unique token that should be used in place of the credit card number in /customer/update/credit-card POST.
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"creditCardToken": {
"id": "http://jsonschema.net/creditCardToken",
"type": "string"
}
},
"required": [
"creditCardToken"
]
}
Example:
{
"creditCardToken": "5288fa42-3984-473a-826f-dab110acc6ea"
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "INVALID_CREDIT_CARD_NUMBER",
"message": "Invalid credit card number",
"field": "number"
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}/customer
Creates a basic customer account with at the very least an email and password.
post
post /customer/create
Body
Type: application/x-www-form-urlencoded
Form Parameters- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- email: required (string - maxLength: 100 - pattern: ^(?=[-0-9A-Za-z@.\\_+]*$).*)
Customer's email address that will be used for logging in and product communication. Must be unique.
Example:
john@email.com
- password: required (string - minLength: 8 - pattern: ^(?=[-a-zA-Z0-9@_*.]*$).*)
Customer's password.
Example:
Jelly22fish
- firstName: (string - maxLength: 60 - pattern: ^(?=[-0-9A-Za-z.#'\s]*$).*)
Customer's first name.
Example:
John
- lastName: (string - maxLength: 60 - pattern: ^(?=[-0-9A-Za-z.#'\s]*$).*)
Customer's last name.
Example:
Smith
- homePhone: (string)
Customer's phone number (can be cell number). Non digits will be stripped.
Example:
714-555-1234
- homeAddress.zip: (string - minLength: 5 - maxLength: 5)
Customer's home address five digit zip code.
Example:
92648
- sponsorCodeString: (string - maxLength: 36)
Unique code associated with a Cobrand that will direct membership costs to the cobrand partner rather than customer. Only applies to smartcredit.com.
Example:
AWESOMECREDITNOW
- planType: (one of FREE, SPONSORED, BASIC, PREMIUM, VIP, BUNDLE)
Plan type selected for customer's membership. Must be one of campaign's signupPlanTypes.
Example:
PREMIUM
HTTP status code 201
A successful response that provides a unique identifier associated with the customer account. That customerToken identifier will be required to make subsequent updates to the customer account.
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"customerToken": {
"type": "string"
},
"PID": {
"type": "string"
},
"isAccountVerificationRequired": {
"description": "If account verification is enabled for the planType under the campaign the customer is signing up under this flag will be returned indicating signup cannot continue until their email is verified.",
"type": "boolean"
},
"isFinancialObligationMet": {
"description": "Whether the customer's financial obligation for signing up has been met. This can be either through being placed on a specific plant type or providing a credit card. This is useful for knowing if credit card collection can be skipped. Note: this can change through the signup process if the customer is moved to a different plan type.",
"type": "boolean"
},
"planType": {
"description": "The membership plan type the customer is currently going to be signed up under.",
"enum": [
"FREE",
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP",
"BUNDLE"
]
}
},
"required": [
"customerToken",
"isFinancialObligationMet",
"planType"
]
}
Example:
{
"customerToken": "b3e9f907-8cc8-4e3a-849b-b16c6eb23682",
"isFinancialObligationMet": false,
"planType": "BASIC",
"PID": "12345"
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "EMAIL_USED",
"message": "Email exists, please choose another email"
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}Updates the customer account with identity information, including social security number, birth date and address. Can also include acknowledgement of terms of membership and an answer to a security question.
post
post /customer/update/identity
Body
Type: application/x-www-form-urlencoded
Form Parameters- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- customerToken: required (string - maxLength: 36)
A unique identifier assigned to a customer account upon its creation that is used to reference that customer through the sign up process.
Example:
7307cecc-274d-4b96-b871-519ae2699c41
- firstName: required (string - maxLength: 60 - pattern: ^(?=[-0-9A-Za-z.#'\s]*$).*)
Customer's first name. Required only if not already provided through /customer/create POST.
Example:
John
- lastName: required (string - maxLength: 60 - pattern: ^(?=[-0-9A-Za-z.#'\s]*$).*)
Customer's last name. Required only if not already provided through /customer/create POST.
Example:
Smith
- homePhone: required (string)
Customer's phone number (can be cell number). Non-digits will be stripped. Required only if not already provided through /customer/create POST.
Example:
714-555-1234
- homeAddress.street: required (string - maxLength: 60 - pattern: ^(?=[-0-9A-Za-z.#'\s]*$).*)
Customer's home address house number and street.
Example:
123 Main St
- homeAddress.street2: (string - maxLength: 60 - pattern: ^(?=[-0-9A-Za-z.#'\s]*$).*)
Customer's home address house number and street. This field can just be appended to the first street field.
Example:
Apt A
- homeAddress.city: (string - default: city looked up by zip - maxLength: 100 - pattern: ^(?=[-0-9A-Za-z.#'\s]*$).*)
Customer's home address city. If not provided the city will be looked up by the zip code.
Example:
Huntington Beach
- homeAddress.state: (string - default: state looked up by zip - minLength: 2 - maxLength: 2)
Customer's home address state. If not provided the state will be looked up by the zip code.
Example:
CA
- homeAddress.zip: required (string - minLength: 5 - maxLength: 5)
Customer's home address five digit zip code.
Example:
92648
- identity.ssnPartial: (string - minLength: 4 - maxLength: 4)
Customer's last four SSN digits. This is used as a lookup for a full SSN and must be present on the first call to /customer/update/identity.
Example:
1234
- identity.ssn: (string - minLength: 9 - maxLength: 11)
Customer's social security number. Dashes will be stripped. This must be present if identity.ssnPartial is not.
Example:
666-24-1234
- identity.birthDate: required (string)
Customer's birth date in the format of MM/dd/yyyy.
Example:
04/15/1990
- securityQuestionAnswer.securityQuestionId: (integer)
Identifier representing the security question that the customer has selected. This ID corresponds to the ID's that can be obtained from /security-questions API resource.
Example:
1 - securityQuestionAnswer.answer: (string)
Customer supplied answer to the security question they have chosen.
Example:
hawk
- isConfirmedTerms: (boolean - default: false)
Acknowledgement that customer has received and accepted the terms of membership. If membership is sponsored, the terms should be confirmed in this step. If it is not sponsored terms can be confirmed with /customer/update/credit-card POST.
Example:
true - confirmTermsBrowserIpAddress: (string - default: if isBrowserConnection = true, the IP address in the HTTP headers)
The IP address of the browser where the customer was shown the terms of membership.
Example:
192.168.1.123
- isBrowserConnection: (boolean - default: false)
Whether the API connection is being made from a web browser or not. If it is, the API will pull the IP from the HTTP headers. If not, confirmTermsBrowserIpAddress should be returned with the IP address.
Example:
true
HTTP status code 200
Returns the home address city and state to accommodate situations where only a zip code was provided and they were looked up by that zip.
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"model": {
"id": "http://jsonschema.net/model",
"type": "object",
"properties": {
"homeAddress.city": {
"id": "http://jsonschema.net/model/homeAddress.city",
"type": "string"
},
"homeAddress.state": {
"id": "http://jsonschema.net/model/homeAddress.state",
"type": "string"
}
},
"required": [
"homeAddress.city",
"homeAddress.state"
]
}
},
"required": [
"model"
]
}
Example:
{
"model": {
"homeAddress.city": "COSTA MESA",
"homeAddress.state": "CA"
}
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "SSN_USED",
"message": "A customer exists with the SSN you entered."
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}Allows the membership plan the customer is being signed up under to be changed independent of other signup data collection.
post
post /customer/update/member-plan
Body
Type: application/x-www-form-urlencoded
Form Parameters- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- customerToken: required (string - maxLength: 36)
A unique identifier assigned to a customer account upon its creation that is used to reference that customer through the sign up process.
Example:
7307cecc-274d-4b96-b871-519ae2699c41
- planType: required (one of FREE, SPONSORED, BASIC, PREMIUM, VIP, BUNDLE)
Plan type selected for customer's membership. Must be one of campaign's signupPlanTypes.
Example:
PREMIUM
HTTP status code 200
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"isFinancialObligationMet": {
"description": "Whether the customer's financial obligation for signing up has been met. This can be either through being placed on a specific plant type or providing a credit card. This is useful for knowing if credit card collection can be skipped. Note: this can change through the signup process if the customer is moved to a different plan type.",
"type": "boolean"
},
"planType": {
"description": "The membership plan type the customer is currently going to be signed up under.",
"enum": [
"FREE",
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP",
"BUNDLE"
]
}
},
"required": [
"isFinancialObligationMet",
"planType"
]
}
Example:
{
"isFinancialObligationMet": true,
"planType": "FREE"
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "PLAN_TYPE_INVALID",
"message": "Plan type choice not allowed"
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}Allows movement to a sonsored membership plan for the customer when a valid sponsor code is provided, independent of other signup data collection.
post
post /customer/update/sponsor-code
Body
Type: application/x-www-form-urlencoded
Form Parameters- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- customerToken: required (string - maxLength: 36)
A unique identifier assigned to a customer account upon its creation that is used to reference that customer through the sign up process.
Example:
7307cecc-274d-4b96-b871-519ae2699c41
- sponsorCodeString: required (string - maxLength: 36)
Unique code associated with a Cobrand that will direct membership costs to the cobrand partner rather than customer. Only applies to smartcredit.com.
Example:
AWESOMECREDITNOW
- isConfirmedTerms: required (boolean - default: false)
Acknowledgement that customer has received and accepted the terms of membership.
Example:
true - confirmTermsBrowserIpAddress: required (string - default: if isBrowserConnection = true, the IP address in the HTTP headers)
The IP address of the browser where the customer was shown the terms of membership.
Example:
192.168.1.123
- isBrowserConnection: (boolean - default: false)
Whether the API connection is being made from a web browser or not. If it is, the API will pull the IP from the HTTP headers. If not, confirmTermsBrowserIpAddress should be returned with the IP address.
Example:
true
HTTP status code 200
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"PID": {
"description": "The publisher ID the customer is now on. Note, this could now be different if the provided sponsor code was under a different PID than the customer had been previously signing up under.",
"type": "string"
},
"isFinancialObligationMet": {
"description": "Whether the customer's financial obligation for signing up has been met. This can be either through being placed on a specific plant type or providing a credit card. This is useful for knowing if credit card collection can be skipped. Note: this can change through the signup process if the customer is moved to a different plan type.",
"type": "boolean"
},
"planType": {
"description": "The membership plan type the customer is currently going to be signed up under.",
"enum": [
"FREE",
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP",
"BUNDLE"
]
}
},
"required": [
"PID",
"isFinancialObligationMet",
"planType"
]
}
Example:
{
"PID": "14002",
"isFinancialObligationMet": true,
"planType": "SPONSORED"
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "SPONSOR_CODE_INVALID",
"message": "The sponsor code provided is invalid, please verify your code"
},
{
"code": "TERMS_NOT_CONFIRMED",
"field": "isConfirmedTerms",
"message": "You must confirm the Terms and Conditions",
"value": "false"
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}Updates the customer account with a credit card. Can also include acknowledgement of terms of membership if not already collected. Billing address may be omitted if same as home address.
post
post /customer/update/credit-card
Body
Type: application/x-www-form-urlencoded
Form Parameters- clientKey: required (string - maxLength: 36)
A unique identifier provided by Consumer Direct to a consumer of the Signup API. All API calls require this parameter to be passed.
Example:
e36fd3bc-093d-11e5-b4c4-0018510053f0
- trackingToken: required (string - maxLength: 36)
A unique identifier returned by the /start API call that is passed with most subsequent API calls to tie them all together.
Example:
53679db0-093e-11e5-b939-0800200c9a66
- customerToken: required (string - maxLength: 36)
A unique identifier assigned to a customer account upon its creation that is used to reference that customer through the sign up process.
Example:
7307cecc-274d-4b96-b871-519ae2699c41
- creditCard.name: (string - default: firstName + lastName - maxLength: 255 - pattern: ^(?=[-0-9A-Za-z.#'\s]*$).*)
Customer's name as it appears on their credit card.
Example:
John Smith
- creditCard.token: required (string - maxLength: 36)
A unique identifier returned by the /validate/credit-card-number API call that is used in place of exchanging the actual credit card number.
Example:
a4ddba9f-9a33-4855-9f3d-4477eb13784b
- creditCard.cvv: required (string - minLength: 3 - maxLength: 4)
CVV is a 3 or 4 digit card verification id located on a credit card.
Example:
123
- creditCard.expirationMonth: required (integer - minimum: 1 - maximum: 12)
The expiration month of the credit card.
Example:
1 - creditCard.expirationYear: required (integer)
The expiration year of the credit card.
Example:
2018 - creditCard.address: (string - default: homeAddress.street - maxLength: 60)
Customer's billing address house number and street.
Example:
123 Main St
- creditCard.city: (string - default: Looked up by creditCard.zip, or if that's empty defaults to homeAddress.city - maxLength: 50)
Customer's billing address city.
Example:
Huntington Beach
- creditCard.state: (string - default: Looked up by creditCard.zip, or if that's empty defaults to homeAddress.state - minLength: 2 - maxLength: 2)
Customer's billing address state. If not provided the state will be looked up by the zip code.
Example:
CA
- creditCard.zip: (string - default: homeAddress.zip - minLength: 5 - maxLength: 5)
Customer's billing address five digit zip code.
Example:
92648
- isMemberPlanOption: (boolean - default: based on MemberPlan configured for PID)
Deprecated, please use planType. Flag to indicate if a customer should be put on the premium membership plan. Not applicable with bundle and sponsor plans.
Example:
true - planType: (one of FREE, SPONSORED, BASIC, PREMIUM, VIP, BUNDLE)
Plan type selected for customer's membership. Must be one of campaign's signupPlanTypes.
Example:
PREMIUM
- isConfirmedTerms: required (boolean - default: false)
Acknowledgement that customer has received and accepted the terms of membership.
Example:
true - confirmTermsBrowserIpAddress: required (string - default: if isBrowserConnection = true, the IP address in the HTTP headers)
The IP address of the browser where the customer was shown the terms of membership.
Example:
192.168.1.123
- isBrowserConnection: (boolean - default: false)
Whether the API connection is being made from a web browser or not. If it is, the API will pull the IP from the HTTP headers. If not, confirmTermsBrowserIpAddress should be returned with the IP address.
Example:
true
HTTP status code 200
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"isFinancialObligationMet": {
"description": "Whether the customer's financial obligation for signing up has been met. This can be either through being placed on a specific plant type or providing a credit card. This is useful for knowing if credit card collection can be skipped. Note: this can change through the signup process if the customer is moved to a different plan type.",
"type": "boolean"
},
"planType": {
"description": "The membership plan type the customer is currently going to be signed up under.",
"enum": [
"FREE",
"SPONSORED",
"BASIC",
"PREMIUM",
"VIP",
"BUNDLE"
]
}
},
"required": [
"isFinancialObligationMet",
"planType"
]
}
Example:
{
"isFinancialObligationMet": false,
"planType": "PREMIUM"
}
HTTP status code 400
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "400",
"message": "Bad Request - Please contact your support representative"
}
]
}HTTP status code 401
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "401",
"message": "Unauthorized - Please contact your support representative"
}
]
}HTTP status code 422
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "CREDIT_CARD_TOKEN_REQUIRED",
"message": "Credit card token is required."
}
]
}
HTTP status code 423
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "423",
"message": "Locked - Please contact your support representative"
}
]
}
HTTP status code 500
Body
Type: application/vnd.cd.signup-api.v1.1+json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"errors": {
"id": "http://jsonschema.net/errors",
"type": "array",
"items": [
{
"id": "http://jsonschema.net/errors/0",
"type": "object",
"properties": {
"code": {
"id": "http://jsonschema.net/errors/1/code",
"type": "string"
},
"message": {
"id": "http://jsonschema.net/errors/1/message",
"type": "string"
},
"field": {
"id": "http://jsonschema.net/errors/1/field",
"type": "string"
},
"value": {
"id": "http://jsonschema.net/errors/1/value",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
],
"minItems": 1,
"uniqueItems": true
}
},
"required": [
"errors"
]
}Example:
{
"errors": [
{
"code": "500",
"message": "Internal Server Error - Please contact your support representative"
}
]
}