{"openapi":"3.1.0","info":{"title":"Keep","version":"1.0.0","description":"APIs for Keep, PayMe's accounting product: partners create and manage sellers, income documents, expenses, and tax and VAT balances, authenticating with OAuth 2.0 client credentials."},"servers":[{"url":"https://<partner_domain>.keep.co.il","description":"Sandbox: your partner domain on the Keep sandbox"},{"url":"https://<partner_domain>.keep.co.il","description":"Production: your partner domain"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"tags":[{"name":"Sellers"}],"paths":{"/api/public/sellers/create":{"post":{"security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"Seller's first name, 2 to 250 characters: letters, spaces and the marks `-` `_` `.` `,` `'` `\"` `״` `(` `)` `:` `;`."},"lastName":{"type":"string","description":"Seller's last name, 2 to 250 characters: letters, spaces and the marks `-` `_` `.` `,` `'` `\"` `״` `(` `)` `:` `;`."},"email":{"type":"string","description":"Seller's primary email address (used for login)"},"contactEmail":{"type":"string","description":"Business contact email address"},"password":{"type":"string","description":"Account password, at least 6 characters."},"phone":{"type":"string","description":"Phone number, 1 to 250 characters."},"businessName":{"type":"string","description":"Legal business name, at most 250 characters."},"businessType":{"type":"integer","description":"Israeli business type.\n\n- `0` Not sure (לא ידוע)\n- `1` Osek Murshe, sole proprietorship (עוסק מורשה)\n- `2` Osek Patur, exempt small business (עוסק פטור)\n- `3` Incorporated company (חברה בע\"מ)\n- `4` Partnership (שותפות)\n- `6` Non-profit (עמותה)\n- `7` Limited partnership (שותפות מוגבלת)\n- `8` Publicly traded company (חברה ציבורית)\n- `9` Shared cooperative (אגודה שיתופית)\n- `10` Public benefit company (חברה לתועלת הציבור)"},"businessNumber":{"type":"string","description":"Israeli business registration number (ח.פ. / עוסק מורשה). Digits only, at most 9, with a valid check digit."},"socialId":{"type":"string","description":"Israeli ID number (תעודת זהות). Digits only, at most 9, with a valid check digit."},"industryClassification":{"type":"number","description":"Industry classification code (optional)"},"bankId":{"type":"string","description":"Israeli bank code (optional) Digits only."},"accountNumber":{"type":"string","description":"Bank account number (optional) Digits only."},"branchNumber":{"type":"string","description":"Bank branch number (optional) Digits only."},"logo":{"type":"string","description":"Business logo as base64 encoded data URI (optional)"}},"required":["firstName","lastName","email","contactEmail","password","phone","businessName","businessType","businessNumber","socialId"]},"example":{"firstName":"David","lastName":"Cohen","email":"david.cohen@example.com","contactEmail":"seller@example.com","password":"securePassword123","phone":"0500000009","businessName":"Cohen Electronics Ltd","businessType":1,"businessNumber":"330988015","socialId":"123456782","industryClassification":12,"bankId":"12","accountNumber":"123456789012345","branchNumber":"123","logo":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."}}}},"responses":{"201":{"description":"Seller created successfully","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"object","properties":{"sellerId":{"type":"string","description":"Newly created seller's UUID"}}}}},"example":{"payload":{"sellerId":"9a5e7898-067e-4c0c-a50f-5f8d83e7c686"}}}}},"400":{"description":"Bad Request. Returned for validation errors, and for these onboarding refusals:\n\n- `Social ID is invalid` — a Keep seller already uses this ID number.\n- `The email is invalid. Please try again` — a Keep account already uses this email.\n\nOther onboarding errors are returned as `400` with their own message.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message(s)"},"error":{"type":"string","description":"Error type"}}},"example":{"statusCode":400,"message":["Value of socialId field should be a valid Social ID"],"error":"Bad Request"}}}},"401":{"description":"Unauthorized","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer"},"message":{"type":"string"}}},"example":{"statusCode":401,"message":"Unauthorized"}}}},"403":{"description":"Forbidden: the access token has no scope this endpoint accepts. Message: `Forbidden resource`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message"},"error":{"type":"string","description":"Error type"}}},"example":{"statusCode":403,"message":"Forbidden resource","error":"Forbidden"}}}}},"operationId":"createseller","summary":"Create seller","tags":["Sellers"],"description":"Register a new seller account with Israeli business compliance validation. Includes validation for Israeli ID numbers, business registration, and bank account details."}},"/api/public/sellers/{sellerId}":{"get":{"security":[{"bearerAuth":[]}],"parameters":[{"name":"sellerId","in":"path","required":true,"description":"Seller UUID or MPL ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Seller retrieved successfully. When no seller matches, `payload` is null.","x-response-kind":"success","content":{"application/json":{"schema":{"type":"object","properties":{"payload":{"type":"object","properties":{"id":{"type":"string","description":"Seller UUID"},"firstName":{"type":"string","description":"Seller's first name"},"lastName":{"type":"string","description":"Seller's last name"},"email":{"type":"string","description":"Primary email address"},"contactEmail":{"type":"string","description":"Business contact email"},"phone":{"type":"string","description":"Phone number"},"businessName":{"type":"string","description":"Legal business name"},"businessType":{"type":"integer","description":"Israeli business type.\n\n- `0` Not sure (לא ידוע)\n- `1` Osek Murshe, sole proprietorship (עוסק מורשה)\n- `2` Osek Patur, exempt small business (עוסק פטור)\n- `3` Incorporated company (חברה בע\"מ)\n- `4` Partnership (שותפות)\n- `6` Non-profit (עמותה)\n- `7` Limited partnership (שותפות מוגבלת)\n- `8` Publicly traded company (חברה ציבורית)\n- `9` Shared cooperative (אגודה שיתופית)\n- `10` Public benefit company (חברה לתועלת הציבור)"},"businessNumber":{"type":"string","description":"Israeli business registration number"},"socialId":{"type":"string","description":"Israeli ID number"},"createdAt":{"type":"string","description":"Account creation timestamp"},"updatedAt":{"type":"string","description":"Last update timestamp"},"sellerStatus":{"type":"integer","description":"`-1` new, `0` closed, `1` active"},"industryClassification":{"type":"integer"}}}}},"example":{"payload":{"id":"97bdce55-b2a2-450d-8d29-1dcf6bbcc419","firstName":"David","lastName":"Cohen","email":"david.cohen@example.com","contactEmail":"seller@example.com","phone":"0500000009","businessName":"Cohen Electronics Ltd","businessType":1,"businessNumber":"330988015","socialId":"123456782","createdAt":"2026-01-22T09:19:54.264Z","updatedAt":"2026-01-22T09:19:54.403Z"}}}}},"401":{"description":"Unauthorized","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer"},"message":{"type":"string"}}},"example":{"statusCode":401,"message":"Unauthorized"}}}},"403":{"description":"Forbidden: the access token has no scope this endpoint accepts. Message: `Forbidden resource`.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message"},"error":{"type":"string","description":"Error type"}}},"example":{"statusCode":403,"message":"Forbidden resource","error":"Forbidden"}}}}},"operationId":"getsellerbyid","summary":"Get seller","tags":["Sellers"],"description":"Retrieve seller information by Keep seller UUID or by MPL. Returns seller details including business information and timestamps."}},"/api/public/sellers/{sellerId}/update":{"put":{"security":[{"bearerAuth":[]}],"parameters":[{"name":"sellerId","in":"path","required":true,"description":"Seller UUID (v4), as returned by Create seller or Get seller. An MPL is not accepted here.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"Seller's first name, 2 to 250 characters: letters, spaces and the marks `-` `_` `.` `,` `'` `\"` `״` `(` `)` `:` `;`."},"lastName":{"type":"string","description":"Seller's last name, 2 to 250 characters: letters, spaces and the marks `-` `_` `.` `,` `'` `\"` `״` `(` `)` `:` `;`."},"email":{"type":"string","description":"Primary email address"},"contactEmail":{"type":"string","description":"Business contact email"},"phone":{"type":"string","description":"Phone number, 1 to 250 characters."},"businessName":{"type":"string","description":"Legal business name, at most 250 characters."},"businessType":{"type":"integer","description":"Israeli business type.\n\n- `0` Not sure (לא ידוע)\n- `1` Osek Murshe, sole proprietorship (עוסק מורשה)\n- `2` Osek Patur, exempt small business (עוסק פטור)\n- `3` Incorporated company (חברה בע\"מ)\n- `4` Partnership (שותפות)\n- `6` Non-profit (עמותה)\n- `7` Limited partnership (שותפות מוגבלת)\n- `8` Publicly traded company (חברה ציבורית)\n- `9` Shared cooperative (אגודה שיתופית)\n- `10` Public benefit company (חברה לתועלת הציבור)"},"businessNumber":{"type":"string","description":"Israeli business registration number (ח.פ. / עוסק מורשה). Digits only, at most 9, with a valid check digit."},"socialId":{"type":"string","description":"Israeli ID number (תעודת זהות). Digits only, at most 9, with a valid check digit."},"industryClassification":{"type":"number","description":"Industry classification code"},"bankId":{"type":"string","description":"Israeli bank code Digits only."},"accountNumber":{"type":"string","description":"Bank account number Digits only."},"branchNumber":{"type":"string","description":"Bank branch number Digits only."},"logo":{"type":"string","description":"Business logo as base64 encoded data URI"}},"required":["firstName","lastName","email","contactEmail","phone","businessName","businessType","businessNumber","socialId"]},"example":{"firstName":"David","lastName":"Cohen","email":"david.cohen1115@example.com","contactEmail":"seller@example.com","phone":"0500000008","businessName":"Cohen Electronics","businessType":2,"businessNumber":"330988015","socialId":"123456782","bankId":"12","accountNumber":"123456789012345","branchNumber":"123","logo":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."}}}},"responses":{"200":{"description":"Seller updated successfully","x-response-kind":"success","content":{"application/json":{"example":{}}}},"400":{"description":"Bad Request. Returned for validation errors, when `sellerId` is not a UUID v4, and with the message `Bad identifier` when the seller does not exist.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message(s)"},"error":{"type":"string","description":"Error type"}}},"example":{"statusCode":400,"message":["Value of socialId field should be a valid Social ID"],"error":"Bad Request"}}}},"401":{"description":"Unauthorized","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer"},"message":{"type":"string"}}},"example":{"statusCode":401,"message":"Unauthorized"}}}},"403":{"description":"The seller does not belong to your partner account. Message: `Forbidden`. Also returned, with the message `Forbidden resource`, when the access token has no scope this endpoint accepts.","x-response-kind":"error","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message"},"error":{"type":"string","description":"Error type: `Forbidden`. Present only with the message `Forbidden resource`."}}},"example":{"statusCode":403,"message":"Forbidden"}}}}},"operationId":"updatesellerbyid","summary":"Update seller","tags":["Sellers"],"description":"Replace a seller's details. Send all required fields on every request."}}}}