Skip to main content

This guide uses the following endpoints

To add an authorized user to an account, you must

  1. Create a person application
  2. Use the additional person application flow
  3. Issue the card

1. Create a Person Application

person_application objects represent natural persons who are applying for new bank accounts or to be added to existing bank accounts. Before you can add a person to an account, you must create a person_application to represent them. To create a person_application, make a POST request to the /apply/person_application endpoint.
This will return the person_application object with a unique id:
The id for person application is prefixed with apsn_, which aids in distinguishing them from the person objects created at the end of the application process.

2. Create an Additional Person Application

Once the person_application representing the authorized user you wish to add to an account has been created, you can add them to the account by making a request to the additional_person_application endpoint:
This will start an additional_person_application to add the supplied person_application to the specified account, with the given role. The response will look like this:
The status of the application will begin in pending and end in approved; once the application is approved, you can issue a card to the new user.

3. Issue the Card

Once the additional_person_application has been approved, you can fetch the person_application attached to it and look up the person created and linked to the account:
The person_id attribute of the person_application object is what is required to create a card; it is prefixed with psn. Once you have the id of the person you wish to issue a card to, you can make a call to issue them a card in the normal way:
This will return a card object: