Links

Projects

Using Swan means using projects. Partners can have anywhere from one project to a large number of projects depending on the use case.
Users can belong to as many projects as needed. They always use the same identifier (their phone number) to sign in.

Project owner

Projects are owned by the legal person who opens a project's first Live account when activating a Swan project.
Additionally, the project owner's legal representative, or legal rep, can perform specific actions, for example implementing security measures such as server consent or viewing their own card numbers with the API.
In Sandbox, you can use the mutation promoteAccountHolderToProjectOwner to promote any account holder in order to test project owner behavior.

Project ID

Each project has a unique Project ID (projectId). On the Dashboard, click-to-copy your Project ID from any page.
Screenshot of the top left corner of the Dashboard with the Swan logo and the project dropdown, Project ID is highlighted
Project ID on the Dashboard

Project access tokens

  • Allow you to act on your own behalf rather than on behalf of a user.
  • Allow you to act as a user within your project, sometimes referred to as impersonation.
  • Must use the client credentials OAuth2 flow (also referred to as grant type), intended for server-to-server authentication.
→ Learn more about project access tokens, including how to retrieve and use them, in the authentication section.

Sandbox and Live projects

Projects always start as Sandbox-only. Projects can remain Sandbox-only if you're goal for the project is to test various implementations.
After a project passes to the status LimitedLiveAccess, the project owner can begin testing the Live implementation. From there, more and more Live access is granted (assuming the project passes reviews).
After a project is Live, you can switch between Sandbox and Live. Use Sandbox to test new features before releasing them to your Live users.
You can't migrate work between projects.
If you have a Live project and you'd like to test an implementation in Sandbox before launching, use that Live project's Sandbox mode.

Project statuses

Status
Actions
Availability
Initiated
Partner creates a project Next: Partner schedules meeting with Swan
Live:
No
Onboarding:
No
MeetingScheduled
Partner schedules a meeting Next: Partner and Swan meet to discuss the Partner's use case and implementation before requesting a review
Live:
No
Onboarding:
No
PendingCompliance
Swan performs a review of the project for risk and compliance reasons Next: Partner starts investigative development of their implementation while Swan performs the review
Live:
No
Onboarding:
Yes for project owner only
No for users and companies
LimitedLiveAccess
Review accepted; Partner can use Swan for their own account only Next: Partner continues testing their development, then requests a review
Live:
Yes
Onboarding:
No (project owner already onboarded)
PendingLiveReview
Partner asks Swan to review; Swan performs a technical review of the Live implementation Next: Partner remains responsive to questions as Swan performs Live review
Live:
Yes
Onboarding:
No
BetaLiveAccess
Swan approves implementation for a limited number of Live accounts Next: Partner begins onboarding a limited number of accounts
Live:
Yes
Onboarding:
Yes (limited number)
FullLiveAccess
Swan approves implementation for full Live access Next: Partner uses their Swan implementation
Live:
Yes
Onboarding:
Yes (unlimited)
Disabled
Project is not longer active (could be due to Partner request, Swan's choice, or a mutual decision) Next: No next steps
Live:
No
Onboarding:
No
Suspended
Project is suspended, either pending a review by Swan or at the Partner's request Next: If due to Swan review, Partner remains responsive to questions as Swan performs the review; if due to Partner request, the Partner should communicate with Swan about reactivating the project
Live:
No
Onboarding:
No
Rejected
Swan rejects the project (reasons vary and are communicated to the Partner or main point of contact) Next: No next steps
Live:
No
Onboarding:
No

Activate your project