v1

latestOpenAPI 3.0.22026-08-04530309.0 KB

Products

Get a single Product

Retrieve overall status about a Product as well as its configuration, availability, and any associated metadata.

get/products/{uid}

Response

A single Product is returned

uidstring

A unique identifier for this resource

namestring

descriptionstring

product_compliance_plan_uidstring

A unique identifier for a Product Compliance Plan

compliance_plan_namestring

customer_typesstring[]

A list of customer types allowed for this Product

prerequisite_product_uidsstring[]

A list of uids referring to Products that a Customer must onboard to before this Product is available

program_uidstring

A unique identifier for a Program

Example response

{
  "uid": "f9VncZny4ejhcPF4",
  "name": "Checking",
  "description": "Supports checking accounts",
  "product_compliance_plan_uid": "Vxf1pY1KHbiJYo1e",
  "compliance_plan_name": "Compliance requirements for checking",
  "customer_types": [
    "primary",
    "sole_proprietor"
  ],
  "prerequisite_product_uids": [
    "DaB7Mjj73Nz2JpHF",
    "x2z691J9HPCWAugv"
  ],
  "profile_requirements": [
    {
      "profile_requirement_uid": "ptRLF7nQvy8VoqM1",
      "profile_requirement": "Please provide your approximate annual income in USD.",
      "category": "default",
      "required": true,
      "response_values": [
        "yes",
        "no"
      ]
    }
  ],
  "program_uid": "W74Jrkxk8bVtvNNj",
  "required_fields": [
    {
      "customer_type": "primary",
      "fields": [
        "city",
        "dob",
        "email",
        "first_name",
        "last_name",
        "phone",
        "postal_code",
        "ssn",
        "state",
        "street1"
      ]
    },
    {
      "customer_type": "sole_proprietor",
      "fields": [
        "business_name",
        "city",
        "dob",
        "email",
        "first_name",
        "last_name",
        "phone",
        "postal_code",
        "ssn",
        "state",
        "street1"
      ]
    }
  ]
}