--- title: "Create" method: POST path: "/items" tags: ["Items"] --- # Create `POST /items` Creates a item and syncs all the products with the financial institution, using as credentials the sent parameters. ## Request body - CreateItem — Create Item Request - `connectorId` number, required — Primary identifier of the connector - `parameters` union, required — Connector's credentials that are required to execute on a Key-Value object or a string if they are encrypted - object - string - `webhookUrl` string, uri — Url to be notified of item changes - `clientUserId` string — Client's external identifier for the user, it can be a ID, UUID or even an email. This is free for clients to use. - `oauthRedirectUri` string, uri — Redirect URI required for the Oauth flow - `products` string[] — Products to be collected in the connection - `avoidDuplicates` boolean — Avoids creating a new item if there is already one with the same credentials ## Response `200` Created item - Item — Item object - `id` string, required — Primary identifier - `connector` Connector — Connector object - `id` number, required — Primary identifier - `name` string — Name of the institution - `institutionUrl` string — Homepage of the institution - `imageUrl` string — Image of the logo hosted by Pluggy - `primaryColor` string — Primary color - `type` string — Type of institution - `country` string — Country located - `credentials` ConnectorCredential[] — Parameters required to start the connection - `name` string, required — Name of the key - `label` string, required — Label for input - `type` 'text' | 'password' | 'number' | 'image' | 'select', required — Type of credential required - `assistiveText` string — Text to help the user when completing the input - `data` string — Used to return base64 images - `placeholder` string — Placeholder text for the input - `validation` string — Regex validation for the user's input - `validationMessage` string — Validation message when input doesn't match the regex - `mfa` boolean — Credential is an MFA parameter and must be refreshed on each execution - `options` CredentialSelectOption[] — List of possible values for the input - `value` string, required — Value for the option - `label` string, required — Label for the option - `hasMFA` boolean — Does the connector require an MFA to execute? - `products` string[] — Products supported by the connector - `oauth` boolean — If 'true', the connector requires an Oauth flow to execute - `oauthUrl` string — URL to perform Oauth flow if needed - `resetPasswordUrl` string — URL to the financial institution to reset the password - `health` ConnectorHealth — Connector health status - `status` string — 'ONLINE' | 'OFFLINE' | 'UNSTABLE' - `stage` string - `details` object — Statistics about your recent connections on the connector and recent connection rate (percentage of healthy connections). This field is only present if you include the parameter healthDetails=true. This will be null if there was an error obtaining health details. - `connectionRateLast6Hours` number — A number from 0 to 100: the percentage of executions that succesfully connect to the institution: status of CONNECTION_ERROR,ERROR,SITE_NOT_AVAILABLE decrease the percentage. Any other status (like SUCCESS/LOGIN_ERROR) increase the percentage. The value will be null if there were no connections - `connectionsLast6Hours` number — Amount of your connections for this connector during the last 6 hours. 0 if there were no connections - `isOpenFinance` boolean — Indicates if the connector uses the regulated Open Finance APIs - `supportsPaymentInitiation` boolean — Indicates if the connector supports the payment initiation API - `supportsScheduledPayments` boolean — Indicates if the connector supports scheduled payments - `supportsSmartTransfers` boolean — Indicates if the connector supports smart transfers - `supportsBoletoManagement` boolean — Indicates if the connector supports boleto management - `supportsAutomaticPix` boolean — Indicates if the connector supports automatic Pix - `createdAt` string, date-time — Date of creation - `updatedAt` string, date-time — Date of last modification - `status` string, required — Status of the Item - `executionStatus` string, required — Status of the sync execution - `error` object — Detailed error message - `code` string, required — Error code - `message` string, required — Detailed error message - `providerMessage` string — Information provider by the institution mainly when user needs to perform an action - `attributes` object — '{ [key]:[value] }'. Additional information necessary for future executions, used for example in some device authorization flow - `parameter` ConnectorCredential — Credential details for a connector - `name` string, required — Name of the key - `label` string, required — Label for input - `type` 'text' | 'password' | 'number' | 'image' | 'select', required — Type of credential required - `assistiveText` string — Text to help the user when completing the input - `data` string — Used to return base64 images - `placeholder` string — Placeholder text for the input - `validation` string — Regex validation for the user's input - `validationMessage` string — Validation message when input doesn't match the regex - `mfa` boolean — Credential is an MFA parameter and must be refreshed on each execution - `options` CredentialSelectOption[] — List of possible values for the input - `value` string, required — Value for the option - `label` string, required — Label for the option - `userAction` ConnectorUserAction — User action details for an item - `instructions` string, required — Instructions related to the user action - `attributes` object — '{ [key]:[value] }'. Additional information related to the user action, for exampke in some device authorization flow - `expiresAt` string, date-time — User action expiration date - `webhookUrl` string — Url to be notified of item changes - `createdAt` string, date-time — Date of creation - `updatedAt` string, date-time — Date of last modification - `lastUpdatedAt` string, date-time — Date of last syncronization - `statusDetail` StatusDetail — Detailed status of the item. This field will be present when the status is PARTIAL_SUCCESS or when a product in the item has warnings - `accounts` StatusDetailProduct — Detailed status of the product - `lastUpdatedAt` string, date-time — Date when the product was last updated - `isUpdated` boolean — Product was updated in the last execution - `warnings` StatusDetailProductWarning[] — Warnings about the product data. For example, a warning about missing permissions for viewing a product - `code` string, required — The warning code generated by Pluggy - `message` string, required — The warning message in english generated by Pluggy - `providerMessage` string — The warning message from the FI if provided - `creditCards` StatusDetailProduct — Detailed status of the product - `lastUpdatedAt` string, date-time — Date when the product was last updated - `isUpdated` boolean — Product was updated in the last execution - `warnings` StatusDetailProductWarning[] — Warnings about the product data. For example, a warning about missing permissions for viewing a product - `code` string, required — The warning code generated by Pluggy - `message` string, required — The warning message in english generated by Pluggy - `providerMessage` string — The warning message from the FI if provided - `transactions` StatusDetailProduct — Detailed status of the product - `lastUpdatedAt` string, date-time — Date when the product was last updated - `isUpdated` boolean — Product was updated in the last execution - `warnings` StatusDetailProductWarning[] — Warnings about the product data. For example, a warning about missing permissions for viewing a product - `code` string, required — The warning code generated by Pluggy - `message` string, required — The warning message in english generated by Pluggy - `providerMessage` string — The warning message from the FI if provided - `investments` StatusDetailProduct — Detailed status of the product - `lastUpdatedAt` string, date-time — Date when the product was last updated - `isUpdated` boolean — Product was updated in the last execution - `warnings` StatusDetailProductWarning[] — Warnings about the product data. For example, a warning about missing permissions for viewing a product - `code` string, required — The warning code generated by Pluggy - `message` string, required — The warning message in english generated by Pluggy - `providerMessage` string — The warning message from the FI if provided - `identity` StatusDetailProduct — Detailed status of the product - `lastUpdatedAt` string, date-time — Date when the product was last updated - `isUpdated` boolean — Product was updated in the last execution - `warnings` StatusDetailProductWarning[] — Warnings about the product data. For example, a warning about missing permissions for viewing a product - `code` string, required — The warning code generated by Pluggy - `message` string, required — The warning message in english generated by Pluggy - `providerMessage` string — The warning message from the FI if provided - `investmentsTransactions` StatusDetailProduct — Detailed status of the product - `lastUpdatedAt` string, date-time — Date when the product was last updated - `isUpdated` boolean — Product was updated in the last execution - `warnings` StatusDetailProductWarning[] — Warnings about the product data. For example, a warning about missing permissions for viewing a product - `code` string, required — The warning code generated by Pluggy - `message` string, required — The warning message in english generated by Pluggy - `providerMessage` string — The warning message from the FI if provided - `paymentData` StatusDetailProduct — Detailed status of the product - `lastUpdatedAt` string, date-time — Date when the product was last updated - `isUpdated` boolean — Product was updated in the last execution - `warnings` StatusDetailProductWarning[] — Warnings about the product data. For example, a warning about missing permissions for viewing a product - `code` string, required — The warning code generated by Pluggy - `message` string, required — The warning message in english generated by Pluggy - `providerMessage` string — The warning message from the FI if provided - `loans` StatusDetailProduct — Detailed status of the product - `lastUpdatedAt` string, date-time — Date when the product was last updated - `isUpdated` boolean — Product was updated in the last execution - `warnings` StatusDetailProductWarning[] — Warnings about the product data. For example, a warning about missing permissions for viewing a product - `code` string, required — The warning code generated by Pluggy - `message` string, required — The warning message in english generated by Pluggy - `providerMessage` string — The warning message from the FI if provided - `accountStatements` StatusDetailProduct — Detailed status of the product - `lastUpdatedAt` string, date-time — Date when the product was last updated - `isUpdated` boolean — Product was updated in the last execution - `warnings` StatusDetailProductWarning[] — Warnings about the product data. For example, a warning about missing permissions for viewing a product - `code` string, required — The warning code generated by Pluggy - `message` string, required — The warning message in english generated by Pluggy - `providerMessage` string — The warning message from the FI if provided - `nextAutoSyncAt` string, date-time — Date of next auto-sync, or null if auto-sync is disabled for this Item - `consecutiveFailedLoginAttempts` number — Consecutives execution that ends up with a LOGIN_ERROR status - `consentExpiresAt` string, date-time — Consent expiration date - `products` string[] — Products collected by the item ## Other responses - `400` — Invalid parameters - `409` — There is a conflict creating an item - `500` — Unexpected error --- [API](https://skmtc.net/pluggy/apis/pluggy-api.md) · [All operations](https://skmtc.net/pluggy/apis/pluggy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pluggy/pluggy-api/versions/75e87ec7f9cd/schema)