Tech Specs

Addresses

Add a new customer address

/registrar/addresses

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

city

string

Required field.

country_code

string

Required field.

View Codes

line_1

string

Required field.

line_2

string

Optional field.

postal_code

string

Required Field.

state_code

string

Required Field.

Request Body Example

    {
      "city": "Houston",
      "country_code": "USA",
      "line_1": "6855 Gulf St",
      "line_2": "Apt 35",
      "postal_code": "77001",
      "state_code": "TX"
    }

Get an address for a customer

/registrar/addresses/{address_id}

GET

Parameters

address_id (path)

string

Required field. Id of customer address.

Request Example

 
    registrar/addresses/{address_id}

Delete an address for a customer

/registrar/addresses/{address_id}

DELETE

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

address_id (path)

string

Required field. UUID of customer address.

Request Example

 
    registrar/addresses/{address_id}

Business

Create a business for business accounts

/registrar/business

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

name

string

Required field.

additional_data

string

Include any additional data to be stored with the business.

addresses

string

Required field. Include business address, all fields are required except line2.

beneficial_owners

string, enum

Required field. Add a beneficial owner to the business. All fields required. Possible options for type are: OWNER or DIRECTOR

description

string

Required field. Description of business.

emails

string

Required field. Add business email.

national_id_number

string

Required field. Add company tax identifier.

phones

string, boolean

Required field. Add phone number and whether or not phone has SMS capabilities.

Request Body Example

    {
      "name": "John Cena Enterprises",
      "additional_data": {
        "description": "John Cena Enterprises focuses on building more jars of pickles than any other company."
      },
      "addresses": {
        "city": "Houston",
        "country_code": "USA",
        "line_1": "6855 Gulf St",
        "line_2": "Apt 35",
        "postal_code": "77001",
        "state_code": "TX"
      },
      "beneficial_owners": {
        "email": "john_cena_rules@gmail.com",
        "name": "John Cena",
        "title": "Mr.",
        "type": "OWNER"
      },
      "description": "John Cena Enterprises focuses on building more jars of pickles than any other company.",
      "emails": {
        "email": "owner@johncenaenterprises.com"
      },
      "national_id_number": "555-22-1111",
      "phones": {
        "has_sms": "true",
        "phone": "543-222-8888"
      }
    }

Get a business for logged in user

/registrar/business

GET

Get business for logged in user

Add a beneficial owner to a business

/registrar/business/beneficial_owners

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

string

Required field. Beneficiary's email.

name

string

Required field. Beneficiary's name.

title

string

Required field. Beneficiary's title.

type

enum

Required field. Possible options are OWNER or DIRECTOR.

Request Body Example

    {
      "email": "john_cena_rules@gmail.com",
      "name": "John Cena",
      "title": "Mr.",
      "type": "OWNER"
    }

Delete a beneficial owner from a business

/registrar/business/beneficial_owners/{beneficial_owner_id}

DELETE

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

beneficial_owner_id (path)

string

Required field. Id of beneficial owner.

Request Example

 
    /business/beneficial_owners/{beneficial_owner_id}

Update a beneficial owner of a business

/registrar/business/beneficial_owners/{beneficial_owner_id}

PATCH

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

beneficial_owner_id

string

Required field. UUID of the beneficial onwer.

Fields

string

Required field. Beneficiary's email.

name

string

Required field. Beneficiary's name.

title

string

Required field. Beneficiary's title.

type

enum

Required field. Possible options are OWNER or DIRECTOR.

Request Body Example

    {
      "email": "john_cena_rules@gmail.com",
      "name": "John Cena",
      "title": "Mr.",
      "type": "OWNER"
    }

Change the name for the current business entity

/registrar/business/change_name

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

name

string

Required field. New name for current business entity.

Request Body Example

    {
      "name": "John Cena, LLC"
    }

Credentials

Get the list of credentials

/registrar/credentials

GET

Get the list of credentials

Generate a new set of credentials for a third party app

/registrar/credentials

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

Description

string

Required field. Description of new credential.

Request Body Example

    {
      "description": "Personal Finance App"
    }

Delete a credential

/registrar/credentials/{credential_id}

DELETE

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

credential_id (path)

string

Required field. Unique identifier of credential.

Request Example

 
    /registrar/credentials/{credential_id}

Get a credential

/registrar/credentials/{credential_id}

GET

Parameters

credential_id (path)

string

Required field. Unique identifier of credential.

Request Example

 
    /registrar/credentials/{credential_id}

Update the description for a credential

/registrar/credentials/{credential_id}

PATCH

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

credential_id (path)

string

Required field. Unique identifier of credential.

Fields

description

string

Required field. Description of credential.

Request Body Example

    {
      "description": "Description of the credential"
    }

Regenerate password for credential

/registrar/credentials/{credential_id}/regenerate_password

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

credential_id (path)

string

Required field. Unique identifier of credential.

Request Example

 
    /registrar/credentials/{credential_id}/regenerate_password

Emails

Add an email address

/registrar/emails

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

string

Required field. Customer email address.

Request Body Example

    {
      "email": "john_cena_rules@gmail.com"
    }

Get an email address

/registrar/emails/{email_id}

GET

Parameters

email_id (path)

string

Required field. Unique identifier of email.

Request Example

 
    /registrar/emails/{email_id}

Delete an email address

/registrar/emails/{email_id}

DELETE

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

email_id

string

Required field. Unique identifier of email.

Request Example

 
    /registrar/emails/{email_id}

Employers

Add an employer

/registrar/employers

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

string

Required field. Employer email address.

name

string

Required field. Employer name.

Request Body Example

    {
      "email": "john_cena@johncenaenterprises.com",
      "name": "John Cena Enterprises"
    }

Delete an employer

/registrar/employers/{employer_id}

DELETE

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

employer_id (path)

string

Required field. Unique identifier of employer id.

Request Example

 
    /registrar/employers/{employer_id}

Entity

Get the entity for the logged in user

/registrar/entity

GET

Get the entity for logged in user

Person

Add the person record to the logged in user

/registrar/person

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

name_first

string

Required field.

name_last

string

Required field.

name_middle

string

Optional field.

name_prefix

string

Optional field.

name_suffix

string

Optional Field.

additional_data

string

Optional Field. Include any additional data about this person.

addresses

string

Required Field. Includes fields from registrar/addresses.

emails

string

Required Field. Include email for this person.

is_employee

boolean

Optional Field. Checks if a person is an employee

national_id_number

string

Required Field. SSN of person.

phones

string

Required Field. Includes sms capability check and phone number.

Request Body Example

    {
      "name_first": "John",
      "name_last": "Cena",
      "name_middle": "",
      "name_prefix": "",
      "name_suffix": "",
      "additional_data": {
        "description": "John Cena"
        },
      "addresses": {
        "city": "Denver",
        "country_code": "USA",
        "line_1": "6855 Pacific St",
        "line_2": "Apt 3A",
        "postal_code": "80014",
        "state_code": "CO"
        },
      "emails": {
        "email": "john_cena@gmail.com"
        },
      "is_employee": "true",
      "national_id_number": "555-11-3322",
      "phones": {
        "has_sms": "true",
        "phone": "543-222-8888"
        }
    }

Get the person record for the logged in user

/registrar/person

GET

Get the person for the logged in user

Change the name for the current entity

/registrar/person/change_name

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

name_first

string

Required field.

name_last

string

Required field.

name_middle

string

Optional field.

name_prefix

string

Optional field.

name_suffix

string

Optional Field.

Request Body Example

    {
      "name_first": "John",
      "name_last": "Cena",
      "name_middle": "Felix Anthony",
      "name_prefix": "Mr.",
      "name_suffix": "Jr."
    }

Phones

Add a phone number

/registrar/phones

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

has_sms

string

Required field. Allows the customer to indicate if they can receive texts.

phone

string

Required field. Phone Number.

Request Body Example

    {
      "has_sms": "true",
      "phone": "543-222-8888"
    }

Get a phone number

/registrar/phones/{phone_id}

GET

Parameters

phone_id (path)

string

Required field. Id of customer phone.

Request Example

 
    registrar/phones/{phone_id}

Delete a phone number

/registrar/phones/{phone_id}

DELETE

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

phone_id (path)

string

Required field. Unique identifier of phone.

Request Example

 
    /registrar/phones/{phone_id}

Reported Incomes

Add a self-reported income

/registrar/reported_incomes

POST

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

Fields

annual_income

integer

Required field.

untaxed_annual_income

integer

Optional field.

Request Body Example

    {
      "annual_income": 100000,
      "untaxed_annual_income": 70000
    }

Get a self-reported income

/registrar/reported_incomes/{reported_income_id}

GET

Parameters

reported_income_id (path)

string

Required field. Id of self-reported income.

Request Example

 
    registrar/reported_incomes/{reported_income_id}

Delete a self-reported income

/registrar/reported_incomes/{reported_income_id}

DELETE

Parameters

Idempotency-Key (header)

string

Required field. Unique identifier to ensure requests are only processed once.

reported_income_id (path)

string

Required field. Unique identifier of self-reported income.

Request Example

 
    /registrar/reported_incomes/{reported_income_id}

Home Open API