Skip to main content

Akoya
Documentation

Customer info

GET

https://sandbox-products.ddp.akoya.com/customers/{version}/{providerId}/current

This product supports use cases such as payment enablement, account opening, and identity verification. Responses return information about the authorized end-user, the customer associated with the id_token used in the call. This information may include, but is not limited to, the customer identifier, name, email, address, and phone number.

To see the response schema, select the 200 response below. For an example payload response, see the 200 example response below the Try it feature.

This product requires consumer consent to share all account holder information.

🛑 The id_token should be used as the bearer token with this call.

Path Parameters

  1. version*

    stringdefault: v2

    Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2

  2. providerId*

    stringdefault: mikomo

    Id of provider

Headers

  1. x-akoya-interaction-type

    string

    Optional but recommended header to include with each data request. Allowed values are `user` or `batch`. `user` indicates a request is prompted by an end-user action. `batch` indicates the request is part of a batch process.

Responses

  1. 200

    OK

    Response Body

    object

      customer

      current customer

        object

          customerId

          string

          Long-term persistent identity of the end-user. This identity must be unique to the owning institution

          name

          The end-user's name

            object

              first

              string

              First or given name. This data element may contain first & last name if not separated.

              middle

              string

              last

              string

              prefix

              string

              Name prefix, e.g. Mr.

              suffix

              string

              Generational or academic suffix

              company

              string

              Company name

          businessCustomer

          The business customer information, only used if 'type' is 'BUSINESS'.

            object

              name

              string

              Name of business customer

              registeredAgents

              array of objects

              A list of registered agents who act on behalf of the business customer

                object

                  first

                  string

                  First or given name. This data element may contain first & last name if not separated.

                  middle

                  string

                  last

                  string

                  prefix

                  string

                  Name prefix, e.g. Mr.

                  suffix

                  string

                  Generational or academic suffix

                  company

                  string

                  Company name

              registeredId

              string

              The registered tax identification number (TIN) or other identifier of business customer

              industryCode

              object

              Industry code and type

                  type

                  string

                  code

                  string

              domicile

              object

              The country and region of the business customer's location

                  region

                  string

                  country

                  string

          addresses

          array of objects

          An array of the customer's physical mail addresses

              line1

              string

              Address line 1. May contain full address if not separated

              line2

              string

              Address line 2

              line3

              string

              Address line 3

              city

              string

              City

              state

              string

              State or province. Deprecated, will remove in FDX V6.0

              region

              string

              State or province or territory. Replaces "state" property

              postalCode

              string

              Postal code

              country

              string

              ISO 3166 Country Code

              type

              string

              Type of address location. One of BUSINESS, HOME, MAILING

          telephones

          array of objects

            object

              number

              string

              type

              string

              HOMEBUSINESSCELLFAX

              country

              string

              Country calling codes defined by ITU-T recommendations E.123 and E.164

          email

          array of strings

          An array of the end-user's electronic mail addresses

            string

          accounts

          array of objects

          List of accounts related to this end-user

            object

              accountId

              string

              Account ID of the related account

              relationship

              string

              Types of relationships between accounts and holders. Suggested values

              AUTHORIZED_USERBUSINESSFOR_BENEFIT_OFFOR_BENEFIT_OF_PRIMARYFOR_BENEFIT_OF_PRIMARY_JOINT_RESTRICTEDFOR_BENEFIT_OF_SECONDARYFOR_BENEFIT_OF_SECONDARY_JOINT_RESTRICTEDFOR_BENEFIT_OF_SOLE_OWNER_RESTRICTEDPOWER_OF_ATTORNEYPRIMARY_JOINT_TENANTSPRIMARYPRIMARY_BORROWERPRIMARY_JOINTSECONDARYSECONDARY_JOINT_TENANTSSECONDARY_BORROWERSECONDARY_JOINTSOLE_OWNERTRUSTEEUNIFORM_TRANSFER_TO_MINOR

    Headers

    1. x-akoya-interaction-idstring

      Akoya tracking id for logging or support.

CTRL + K

Try it

Authorization

const options = {
	"method": "GET",
	"headers": {
		"x-akoya-interaction-type": "batch"
	}
}};
fetch('https://sandbox-products.ddp.akoya.com/customers/v2/mikomo/current', options)
  .then(response => response.json())
  .catch(err => console.error(err));
Customers guideAccount holder information