# Apivom Atlas — IYS API

> Apivom Atlas integration for IYS API: 59 gateway routes over `api.iys.org.tr`, available through the Apivom platform (Apivom Iris workflows and the Apivom Atlas API portal). Auth model: caller-supplied token passed through to the vendor.

Notes for AI assistants:

- This catalog mirrors the vendor's public API surface as registered in Apivom Atlas (0 read-only, 59 write routes).
- Access is provisioned per customer. Commercialized providers are self-service in the Atlas portal; for everything else [request a demo](https://apivom.com/en/demo).
- Credentials are always owned by the calling tenant — Apivom Atlas is a stateless gateway.

## Routes

- `GET /info/city` (info-city)
- `GET /info/city/{code}` (info-city-by-code) — params: params
- `GET /info/town` (info-town)
- `GET /info/town/{code}` (info-town-by-code) — params: params
- `GET /integrator/{integratorCode}/sps` (integrator-by-integratorcode-sps) — params: params, query
- `GET /integrator/{integratorCode}/sps/{iysCode}` (integrator-by-integratorcode-sps-by-iyscode) — params: params
- `GET /integrator/{integratorCode}/subscription` (integrator-by-integratorcode-subscription) — params: params
- `POST /otp-management/api/v1/{iysCode}/email/start` (otp-management-api-v1-by-iyscode-email-start-post) — params: email, templateId, vkn
- `POST /otp-management/api/v1/{iysCode}/email/start/short-url` (otp-management-api-v1-by-iyscode-email-start-short-url-post) — params: email, templateId, vkn
- `POST /otp-management/api/v1/{iysCode}/sms/start` (otp-management-api-v1-by-iyscode-sms-start-post) — params: phoneNumber, templateId, vkn
- `POST /otp-management/api/v1/{iysCode}/sms/start/short-url` (otp-management-api-v1-by-iyscode-sms-start-short-url-post) — params: phoneNumber, templateId, vkn
- `POST /otp-management/api/v1/email/complete` (otp-management-api-v1-email-complete-post) — params: otpCode, requestId
- `GET /otp-management/api/v1/get-clarification-file/{iysCode}/{requestId}` (otp-management-api-v1-get-clarification-file-by-iyscode-by-requestid) — params: params
- `POST /otp-management/api/v1/recipient-history` (otp-management-api-v1-recipient-history-post) — params: iysCode, brandCode, status, recipient, requestType, verificationType, startDate, endDate, recipientType
- `POST /otp-management/api/v1/request-history` (otp-management-api-v1-request-history-post) — params: requestId
- `POST /otp-management/api/v1/sms/complete` (otp-management-api-v1-sms-complete-post) — params: otpCode, requestId
- `GET /otp-management/api/v1/subscription/{iysCode}` (otp-management-api-v1-subscription-by-iyscode) — params: params
- `GET /sps/{iysCode}/brands` (sps-by-iyscode-brands) — params: params
- `GET /sps/{iysCode}/brands/{brandCode}/agreements/{reportDate}` (sps-by-iyscode-brands-by-brandcode-agreements-by-reportdate) — params: params
- `PUT /sps/{iysCode}/brands/{brandCode}/agreements/{reportDate}` (sps-by-iyscode-brands-by-brandcode-agreements-by-reportdate-put) — params: agreementStatus
- `GET /sps/{iysCode}/brands/{brandCode}/agreements/{reportDate}/timestamp` (sps-by-iyscode-brands-by-brandcode-agreements-by-reportdate-timestamp) — params: params
- `GET /sps/{iysCode}/brands/{brandCode}/changes/{reportDate}/file` (sps-by-iyscode-brands-by-brandcode-changes-by-reportdate-file) — params: params
- `GET /sps/{iysCode}/brands/{brandCode}/changes/{reportDate}/recipients/{recipientType}` (sps-by-iyscode-brands-by-brandcode-changes-by-reportdate-recipients-by-recipienttype) — params: params
- `POST /sps/{iysCode}/brands/{brandCode}/consent/retailers/access/list` (sps-by-iyscode-brands-by-brandcode-consent-retailers-access-list-post) — params: recipient, type, recipientType
- `POST /sps/{iysCode}/brands/{brandCode}/consents/{recipientType}/status/{type}` (sps-by-iyscode-brands-by-brandcode-consents-by-recipienttype-status-by-type-post) — params: recipients
- `GET /sps/{iysCode}/brands/{brandCode}/consents/changes` (sps-by-iyscode-brands-by-brandcode-consents-changes) — params: params, query
- `POST /sps/{iysCode}/brands/{brandCode}/consents/history` (sps-by-iyscode-brands-by-brandcode-consents-history-post) — params: recipient, recipientType, type
- `POST /sps/{iysCode}/brands/{brandCode}/consents` (sps-by-iyscode-brands-by-brandcode-consents-post) — params: recipient, type, source, status, consentDate, recipientType, retailerCode, retailerAccess
- `GET /sps/{iysCode}/brands/{brandCode}/consents/request/{requestId}` (sps-by-iyscode-brands-by-brandcode-consents-request-by-requestid) — params: params
- `POST /sps/{iysCode}/brands/{brandCode}/consents/request` (sps-by-iyscode-brands-by-brandcode-consents-request-post) — params: params, body
- `POST /sps/{iysCode}/brands/{brandCode}/consents/retailers/access` (sps-by-iyscode-brands-by-brandcode-consents-retailers-access-post) — params: type, recipient, recipientType, retailerAccess
- `PUT /sps/{iysCode}/brands/{brandCode}/consents/retailers/access` (sps-by-iyscode-brands-by-brandcode-consents-retailers-access-put) — params: type, recipientType, retailerAccess, recipients
- `POST /sps/{iysCode}/brands/{brandCode}/consents/retailers/access/remove/all` (sps-by-iyscode-brands-by-brandcode-consents-retailers-access-remove-all-post) — params: type, recipientType, recipients
- `POST /sps/{iysCode}/brands/{brandCode}/consents/retailers/access/remove` (sps-by-iyscode-brands-by-brandcode-consents-retailers-access-remove-post) — params: type, recipientType, recipients, retailerAccess
- `POST /sps/{iysCode}/brands/{brandCode}/consents/status` (sps-by-iyscode-brands-by-brandcode-consents-status-post) — params: recipient, recipientType, type
- `GET /sps/{iysCode}/brands/{brandCode}/push/registration` (sps-by-iyscode-brands-by-brandcode-push-registration) — params: params
- `POST /sps/{iysCode}/brands/{brandCode}/push/registration` (sps-by-iyscode-brands-by-brandcode-push-registration-post) — params: connection
- `POST /sps/{iysCode}/brands/{brandCode}/push/unregistration` (sps-by-iyscode-brands-by-brandcode-push-unregistration-post) — params: url, type, username, password
- `GET /sps/{iysCode}/brands/{brandCode}/retailers` (sps-by-iyscode-brands-by-brandcode-retailers) — params: params, query
- `GET /sps/{iysCode}/brands/{brandCode}/retailers/{retailerCode}` (sps-by-iyscode-brands-by-brandcode-retailers-by-retailercode) — params: params
- `DELETE /sps/{iysCode}/brands/{brandCode}/retailers/{retailerCode}` (sps-by-iyscode-brands-by-brandcode-retailers-by-retailercode-delete) — params: params
- `POST /sps/{iysCode}/brands/{brandCode}/retailers` (sps-by-iyscode-brands-by-brandcode-retailers-post) — params: title, mersis, alias, name, tckn, mobile, city, town, status, tin
- `POST /sps/{iysCode}/brands/{brandCode}/via-hash-links` (sps-by-iyscode-brands-by-brandcode-via-hash-links-post) — params: recipients
- `GET /sps/{iysCode}/subscription` (sps-by-iyscode-subscription) — params: params
- `POST /v2/sps/{iysCode}/brands/{brandCode}/consents` (v2-sps-by-iyscode-brands-by-brandcode-consents-post) — params: recipient, type, source, status, consentDate, recipientType, retailerCode, retailerAccess
- `GET /v2/sps/{iysCode}/brands/{brandCode}/consents/request/{requestId}` (v2-sps-by-iyscode-brands-by-brandcode-consents-request-by-requestid) — params: params
- `POST /v2/sps/{iysCode}/brands/{brandCode}/consents/request` (v2-sps-by-iyscode-brands-by-brandcode-consents-request-post) — params: params, body
- `POST /via/sps/{iysCode}/confirmation` (via-sps-by-iyscode-confirmation-post) — params: formId, recipient, verificationType, consentTypes
- `GET /via/sps/{iysCode}/consent/{requestId}` (via-sps-by-iyscode-consent-by-requestid) — params: params
- `POST /via/sps/{iysCode}/consent` (via-sps-by-iyscode-consent-post) — params: formId, recipient, verificationType, consentTypes
- `GET /via/sps/{iysCode}/consent/request/{requestId}` (via-sps-by-iyscode-consent-request-by-requestid) — params: params
- `POST /via/sps/{iysCode}/consent/status` (via-sps-by-iyscode-consent-status-post) — params: type, recipient
- `GET /via/sps/{iysCode}/via/clarification/{requestId}/file` (via-sps-by-iyscode-via-clarification-by-requestid-file) — params: params
- `GET /widget/load-widget/{{widgetUUID}}?apinoncekey={{apiNonceKey}}` (widget-load-widget-by-widgetuuid-apinoncekey-apinoncekey-) — params: params
- `GET /widget/load-widget/{{widgetUUID}}?apinoncekey={{apiNonceKey}}_copy` (widget-load-widget-widgetuuid-apinoncekey-apinoncekey-copy) — params: params
- `GET /widget/load-widgetloader/{{widgetUUID}}` (widget-load-widgetloader-by-widgetuuid-) — params: params
- `POST /widget/process/complete/{widgetUUID}` (widget-process-complete-by-widgetuuid-post) — params: requestId, otpCode, verificationType, cookieKey, csrfToken, nonceKey, consentType
- `POST /widget/process/start/{widgetUUID}` (widget-process-start-by-widgetuuid-post) — params: etkTypes, kvkTypes, recipient, verificationType, recipientType, captchaText, cid, cookieKey, csrfToken, widgetUUID, nonceKey, citizenName
- `GET /widget/publicKey/{{widgetUUID}}` (widget-publickey-by-widgetuuid-) — params: params

## Credential model

- IYS API Access Token (`accessToken`) — required — secret

## Optional

- [Apivom Atlas product page](https://apivom.com/en/products/atlas)
- [All Atlas integration guides](https://apivom.com/llms.txt)
- [Request a demo](https://apivom.com/en/demo)