| \nNote: Zip’s API documentation is available only through an authenticated Zip session. Zip does not currently provide a public OpenAPI specification, full Postman collection, or PDF export of the API reference.\n |
To access Zip's API documentation, log in to your Zip account and click the question mark icon.
Then, select API Documentation from the drop-down menu.
After that, Zip automatically handles the authentication into the gated API docs and the API documentation opens in a new tab.
For implementation guidance, see the Guides in the API documentation. They cover topics such as API authentication, API rate limits, and managing paginated responses.
To give an engineer or external security reviewer access, use one of the following options:
Zip Academy offers a full suite of learning resources to help you get the most out of Zip’s platform:
\nLearn the basics of Zip administration with short, engaging videos and practice scenarios you can complete when it’s most convenient.
\nSign up for expert-led live training sessions where you will test your knowledge with guided hands-on practice and have time to ask questions.
\nShow off your knowledge by passing exams and earning certificates that can be shared with your network on LinkedIn.
\nSearch by keyword or use filters, such as role or difficulty, to find the most helpful training right when you need it.
\n\n
\n
Once signed into the Zip platform, access Zip Academy at https://academy.ziphq.com/
\n\n
If you are having issues accessing the site, please try accessing it from the Product training section of the help dropdown (question mark icon) in Zip.
\nZip is a scalable service that helps organizations manage purchase requests via custom, dynamic workflows. Requests can be submitted by anyone in the organization, and Zip gathers the required purchase information dynamically based on the requester and the product or service being requested. Zip routes purchase requests to the appropriate internal parties for approval automatically, and anyone in the organization who has sufficient permissions can easily check the status of an existing request.
Zip can also facilitate the collection and scoring of RFx survey responses (e.g., for RFIs, RFPs, or RFQs), to help your potential customers with the sourcing process.
Once a purchase request has been fully approved, Zip can generate purchase orders (POs) and help your potential customer send them to you. Customers who use Zip's payment module can process your invoices and issue payment to your company through Zip.
The Zip vendor app is a service hosted securely by Zip that lets your company create and manage a vendor profile that you can share securely with any customer you like (including non-Zip customers) via email invitation. This lets you enter and upload basic details about your company once and then reuse that information to complete onboarding with new customers more quickly.
One component of the Zip vendor app is the Zip vendor portal, which is section of the vendor app dedicated to one specific purchase request associated with a potential customer. The customer can use the vendor portal to request a series of tasks from your company--such as filling out surveys and uploading documentation--to help them onboard your company as a vendor in their ERP or other systems. You can view and access all of your Zip customers' portals individually through your vendor app login.
| \nNote: New users cannot sign in to the Zip vendor app without using a link received in an invitation, either from a potential customer or another member of your company. |
| \nNote: Returning users who have already registered a password and a multi-factor authentication method can sign in to the Zip vendor app on demand at https://vendor.ziphq.com. |
| \nImportant: Register each user using their individual work email address instead of a shared or team email address. It is impossible--even for Zip support--to reset multi-factor authentication (MFA) for a shared or team email address. Therefore, if a user whose phone number or authenticator app is tied to a shared login leaves your team, you would have to add additional individual login users to recover access. |
Zip places a high priority on the security of your company's information. Since the vendor app may contain sensitive information including your company's payment account details, Zip requires multi-factor authentication (MFA) when logging in to the app.
In order to sign in, users must perform multiple steps to verify their identity:
The multi-factor authentication requirement ensures that even if an adversary were to gain access to a vendor contact's username and password, the adversary would be unable to sign in, since they could not access the vendor contact's actual email account or mobile phone.
The first time a new user signs in to the vendor app, the sign-in process is slightly different compared to that of a returning user.
You will initially receive an email invitation to the vendor portal from your potential customer. The message body might look something like the following illustration. Your potential customer's company name and logo may appear at the top, and the tasks that your potential customer is requesting may vary based on their vendor creation requirements.
When you click Get started, you are taken to the Create a password page. Your email address is filled automatically and cannot be edited, since this is the address to which your potential customer sent the vendor portal invitation. Enter a strong password meeting the requirements shown on this page, re-enter it to confirm it, and then click Create password.
On the next page, Zip prompts you to set up multi-factor authentication (MFA). This controls how you will log in to the Zip vendor app now and in the future. You can choose to receive one-time authenticator codes via a call or text message, or generate fresh codes using an authenticator app on your mobile device; any app that supports TOTP (temporary one-time password), such as Google Authenticator™, is compatible.
| \n Important: The multi-factor authentication method you choose here (phone number or authenticator app) will be associated with your email address for future logins. Once you have logged in using that method, you cannot change to the other method unless you reset your authenticator. \n\n |
If you want to receive one-time authentication codes via a call or text each time you log in to the vendor app, enter your phone number.
If you prefer to use authenticator codes generated via an authenticator app instead, click Use authenticator app instead.
When you enter your phone number and click Send by text or Get a phone call, Zip immediately sends your verification code to your phone (or places an automated phone call with the code)...
...and the Enter your code page appears.
Enter your six-digit security code in the spaces provided. When you enter the sixth digit correctly, Zip automatically submits the code, so it is usually not necessary to click Verify. You are logged into the Zip portal. Once you have verified your phone number by entering the security code, that phone number will serve as an authenticator for future login attempts.
As a new user, if you do not receive the initial text or call with your security code within five minutes, you can click Request a new code to re-send the code, and try entering it again.
Alternatively, you can click Use authenticator app instead to switch authentication methods.
When you click Use authenticator app instead on the Enter your phone number page or the Enter your code page, the Set up authenticator page appears. On your mobile device, open the authenticator app of your preference (any app that supports TOTP, such as Google Authenticator™, will work) and scan the provided QR code.
If you prefer to authenticate using codes sent to a phone number instead, click <- Back to return to the Enter your phone number page.
If you have any issues scanning the QR code, you can click the down error next to Trouble scanning? and retrieve an alphanumeric code that can be entered into your authenticator app manually instead.
Once you have scanned the QR code or entered the code shown on the screen into your authenticator application, the app will provide a six-digit numeric code that automatically refreshes periodically. To log in, click Enter code.
Enter the current code from your authenticator app. When the code is entered correctly, Zip will automatically process your login upon receiving the sixth digit so it is usually not necessary to click Verify. You are logged in to the vendor app.
Once you have logged in successfully for the first time using an authenticator app, that app will be associated with your email address and you will use it each time you log in to the Zip vendor app in the future. You will not be able to switch to receiving codes via a call or text message unless you reset your authenticator.
If you do not act on the original invitation email message for more than than thirty days, Zip will automatically disable the login creation process for your email address. You will need to request a new vendor portal invitation from your potential customer. Please check the sender's email address shown in the body of the invitation email message.
Your potential customer can easily send a reminder invitation via the request detail page of the associated purchase request in Zip.
As a new user, Zip attempts to match your email domain with an existing vendor organization that is already set up on the Zip vendor app. For example, if your email address is john.doe@trustysteed.com, Zip looks for a vendor organization matching the domain trustysteed.com.
| \nImportant: If you represent a company that has multiple subsidiaries or entities which may receive purchase requests or purchase orders, you may want to create a separate vendor organization for each subsidiary. In that case, Zip recommends that you ensure each organization name clearly reflects the specific subsidiary. This will make it easier for you and your associates to choose the correct organization--or choose to make a new one--for the relevant subsidiary. |
| \nNote: If your email addresses uses a free email server such as gmail.com, Zip does not attempt to match your domain to an organization. You will instead bypass this step and land directly on the vendor portal once you have logged in, with a newly created vendor organization. |
If Zip finds an organization matching your email domain, the Choose your organization page appears.
If your vendor organization is listed, click Choose. You are logged in to the Zip Vendor app immediately.
If you do not see your vendor organization listed, click the Can't find your company? link at the bottom of the page. A dialog appears with the contact information for Zip's support team.
You can click Create new at the bottom of this dialog to create a new vendor organization, or click Choose existing org to close the dialog so you can join one of the organizations listed on the page.
In case Zip does not find any organization matching your email domain--or if you click Can't find your company? and then click Create new--Zip prompts you to choose whether you are signing up as a company or team, or as an individual contractor.
Your answer to this question determines which version of the sign-up page will appear next; if you choose to sign up as an individual contractor, you will see a reduced set of features. For example, the options to invite teammates during the signup process are not presented on the contractor version of the page.
Either way, you can enter more information about your account on the next page.
Next, scroll down to the Add your contact information section.
On the next page, Zip may prompt you to confirm the initial signup experience for new team members joining your vendor organization on the Zip vendor app in response to other customers' invitations. If you did not select the check box labeled Let people with (your email domain) email immediately join this organization when invited by a customer, the next page illustrates how the joining experience will work for your teammates when invited by other customers.
You can control whether new team members with your email domain can join the organization immediately, or whether you must invite them directly from within the Zip vendor app.
Click Select for the desired option and then click Done. You can change this setting at any time.
The vendor app opens to the customer portal for which you received the invitation.
| \nNote: If the original customer who invited you to the vendor portal invites other members of your team with the same email domain to the same or other vendor portals, your team members may not be required to choose an organization. Zip can automatically assign them to your organization with permissions limited to the single vendor portal to which they have been invited. You and other team members who are administrators will be able to modify the access permissions for all users in your organization. |
After you have initially created your login password and configured your multi-factor authentication, the vendor app login process will be slightly different. You can begin logging in to the vendor app using the link provided in the original invitation email message (or any other invitation message from your potential customer).
| \nNote: Returning users can sign in to the Zip vendor app at https://vendor.ziphq.com. |
On the Log in page, enter your email address and click Next.
Enter your password in the Password field and then click Log in.
When you click Log in, the vendor app prompts you to perform multi-factor authentication (MFA) using the method you chose the first time you logged in to the vendor app (either by entering a code sent to your phone via text message or phone call, or by entering the current Zip vendor app code from your authenticator app).
Once you have completed the second step of multi-factor authentication, the Check your email on this device page appears.
Check your email for a new message with a sign-in link.
When you click the Sign in button, you are signed into the vendor app.
If you forget your password, you can reset it by clicking the Forgot your password? link below the Log in button. Zip will send you an email message containing a link you can use to reset your password. When you click the button in the message, Zip prompts you to perform multi-factor authentication using the method associated with your email address.
If you do not receive a text message or a call when you click Send by text or Get a phone call, you can click Resend code to try sending the code again.
Regardless of whether you have chosen to perform multi-factor authentication using a code texted or called to your phone number or using an authenticator app, if you lose access to your phone, you can reset your authenticator. This process may take up to three days. For more information, please see Resetting Your Authenticator, below.
If you lose access to your authenticator (i.e., your mobile phone), or if your phone number changes, you can reset your authenticator. This process requires third-party verification of your identity, and it may take three to five days to complete. Upon completion, you can switch authentication methods (from a phone number to an authenticator app, or vice versa), or continue using the same method but with a new phone number or authenticator app.
To reset your authenticator, click Reset your multi-factor authentication on any page in the login process where the link appears.
In the Change your authenticator method dialog, click the toggle switch labeled I understand and consent to using a third party service to validate my identity. The toggle switch is turned off by default, as shown in the following illustration.
You cannot click Submit unless you consent to using a third-party service to validate your identity and click the toggle switch to turn it on.
When you click Submit, Zip displays an acknowledgement that your MFA reset request has been initiated.
Zip automatically sends a text message to your current authenticator/phone number, if applicable, to confirm that you have requested the reset.
At the same time, Zip emails your organization's administrators a notification of your request.
Your administrators can click Cancel reset request to cancel the reset if necessary.
Zip also sends an email message to your inbox:
To continue with the reset process, click Continue to ID validation in the email message body.
This opens a new browser tab to Zip's third-party identification verification service. On their site, you can step through the ID verification process so that they can confirm the reset request originated from the actual user who requested it.
Once the third-party verification process is complete, Zip performs an additional validation of the information returned by the third-party verification service. If the validation succeeds, the previous authenticator associated with your email address is deleted from Zip's records. The next time you enter your email address and password on the vendor app, Zip will prompt you to enter a new phone number or set up a new authenticator app for future authentication.
| \nNote: The identity verification process may take several days. |
If your account uses a shared or team email address, you cannot reset multi-factor authentication (MFA) or the registered phone number.
To verify your identity, the first and last name on your government-issued ID must match the name on your account. Because a shared email address is not associated with you as a named individual, Zip cannot complete the identity verification process or override this requirement. Therefore, we highly recommend that you register using your individual work email address from the beginning, instead of a shared or team email address.
If you want to restore access, ask an existing Zip vendor app administrator or your buying customer to invite you as a new user using your individual work email address and assign the appropriate permissions. The Zip vendor app administrator can refer to How Do I Invite Teammates to the Vendor App?, while the buying customer can refer to Sending the Vendor Portal for more information.
Some users' email addresses may be associated with both a vendor profile and a Zip buyer organization. If this applies to you and you have log in access to the buyer organization, you can switch between accessing the vendor app and your Zip buyer organization by clicking the account switcher at the top left-hand corner of the page.
While logged into the vendor app, the Launch buyer app button appears. Likewise, if you are logged into the Zip buyer organization, the Launch vendor app button will appear at the bottom of the account switcher.
","user_segment_ids":[]}],"sort_by":"position","sort_order":"asc"}