๐Ÿ”—
Linker Studio
  • Welcome!!
  • ๐Ÿš€GETTING STARTED
    • Set up your custom project from Linker Studio
    • How to run the project
    • Linker Features
      • Glossary
      • Web
      • Mobile
        • Aggregators
        • Analytics
        • Authentication
        • BaaS
        • Carousel
        • Client Support
        • Error and Crash Reporting
        • Info Onboarding
        • KYC
        • Payroll
        • Pii Onboarding
        • Push Notifications - OneSignal
        • Settings
        • Subscriptions
      • Backend
        • Authentication
        • MFA
        • BaaS
        • Aggregators
        • Notifications
        • Payments
        • Deposit Switching
        • Support
        • Vault
        • Storage
        • Monitoring
        • Analytics
  • ๐Ÿ–ฅ๏ธWEB FEATURES
    • Page 2
  • ๐Ÿ“ฑMobile App Features
    • Project File Structure
    • Figma Tokens Integration
    • Core Module
      • Core UI Components
        • Atoms
        • Molecules
        • Organisms
        • Templates
      • Core Elements
      • Hooks
        • Force update
      • Endpoints used
      • States And Selectors
        • contentsDocuments
    • Modules
      • [New Feature Template]- Feature Name
        • UI Components - Template
          • Atoms
          • Molecules
          • Organisms
          • Templates
        • Hooks - Template
        • Endpoints Used
        • States and Selectors - Template
      • ๐Ÿ“ฅKYC
        • Alloy
        • Baas
          • UI Components
            • Templates
          • Hooks - Template
          • Endpoints Used
          • States and Selectors - Template
        • common
          • UI Components
            • Templates
          • Endpoints Used
      • ๐ŸคAggregators
        • Plaid
          • Plaid/Rize notification before disabling account
      • ๐Ÿค–Analytics
        • Amplitude
      • ๐Ÿ”Authentication
        • Hooks
        • Auth0
          • Hooks
            • Login
            • Forgot password
          • ๐Ÿ“งVerify Email
            • Hooks
        • Biometrics
          • Hooks
        • Auto Logout
        • States And Selectors
          • Authentication
      • ๐Ÿ’ฐBaaS
        • Common
          • BaaS Navigation
          • External Accounts
          • UI Components
            • Molecules
            • Organisms
            • Templates
          • Hooks
            • Statements
            • Recurrent Transfers
            • Cards
              • Get Full Card
              • Lock and Unlock
              • Request Physical Debit Card
              • Reissue Debit Card
              • Set / Reset Debit Card Pin
            • Transfer
          • States And Selectors
            • Customer
            • Accounts
            • Cards
            • Transactions
          • Endpoints used
          • Constants
            • ACH_SERVICES
        • treasury
          • Constants
            • CONFIG_VALUES
      • ๐Ÿ›‚Client Support
      • ๐Ÿ›Error and Crash Reporting
        • Crashlytics
      • โ„น๏ธInfo Onboarding
        • States and Selectors
        • Hooks
          • Physical Card Request
      • ๐ŸŒฏLinker Wrapper
        • Linker Wrapper Messages Structure
        • Linker Wrapper Features
          • Push Notifications
            • Braze
          • In-App Purchase
      • ๐Ÿ›—MFA Verification Code
        • UI Components
          • Molecules
          • Templates
        • Hooks
        • Endpoints used
        • Configurable Constants
      • ๐Ÿ—ž๏ธPayroll
        • UI Components
          • Organisms
          • Templates
        • Hooks
        • States and Selectors
      • ๐Ÿ“‹PII Onboarding
        • UI Components
          • Atoms
          • Molecules
          • Organisms
          • Templates
        • Hooks
        • States and Selectors
      • ๐Ÿ””Push Notifications
        • OneSignal
      • ๐Ÿ”งSettings
      • ๐Ÿ—„๏ธVault
        • VGS Show
        • VGS Collect
    • Cookbook
      • ๐ŸฆNeobank
        • Linked Functionalities
          • Edit Personal Details Linking
          • Request Physical Debit Card Linking
          • Get customer Data after SignUp/Login
  • โ›“๏ธBackend API
    • Environments
    • Migrations
      • Configuration
      • Migration Commands
      • Base Model
      • Migration Structure
    • Seeds and Factories
      • Configuration
      • Seeds And Factories
    • SoftDelete
    • DB Fields Encryption
    • DB Structure
    • DB Configuration Table
      • API Endpoints
    • Orchestrator
    • Swagger
      • Setup
      • Decorators for Requests and Responses
      • Decorators for Controllers and HTTP Responses
      • Auth Decorator
      • Multiple Decorators
  • ๐Ÿช™Finance Integrations
    • Recurring Transfers
      • Architecture
      • Jobs Server
      • Functionality
      • BaaS
        • Rize API Endpoints
        • Treasury Prime API Endpoints
        • Business Treasury Prime API Endpoints
    • BaaS
      • Rize
        • Env Variables
        • Rize API authentication
        • Onboarding
          • Customer Enrollment
          • Get Compliance Workflow
          • Acknowledge Compliance Workflow
          • Customer Complete Enrollment
        • KYC - Know Your Customer
          • Get KYC Documents
          • Upload KYC Document
        • Accounts
          • Get Customer Accounts
          • Get Customer Account By ID
          • Create Customer Account
          • Archive Customer Account
          • Get ACH Customer Accounts
        • Debit Cards
          • Get Debit Cards
          • Get Debit Card Image
          • Lock Debit Card
          • Unlock Debit Card
          • Create Physical Card
          • Activate Debit Card
          • Get Debit Card Set-Pin URL
          • Reissue Debit Card
        • Transactions
          • Get Transactions
        • Transfers
          • Internal Transfers
          • ACH transfers
        • Statements
          • Get Statements
          • Get Statement Document
        • Fake Transactions
        • Message Queue
        • Web Sockets
        • API Endpoints
          • Account Enums
          • Debit Card Enums
          • Transaction Enums
          • KYC Enums
      • Galileo
        • Environment Variables
        • Onboarding
          • Get Customer
          • Customer Enrollment
          • Customer Complete Enrollment
        • Customer Management
          • Get Profile
          • Update Profile
        • Accounts
        • Add Accounts
        • Card Management
          • Get Debit Cards
          • Get Image Card
          • Card Statuses
          • Debit Card Activation
          • Request Physical Card
          • Set PIN
          • Lock/Unlock
        • Transfer
        • Transactions
          • Get Transactions
          • Filter Transactions
        • ACH
          • Add ACH Account
          • Get ACH Accounts
          • Remove ACH Account
          • ACH Transactions
        • Statements
        • Plaid Integration
      • Synapse
        • Environment Variables
        • Terminology
        • Resources
        • API Endpoints
    • Aggregators
      • Add Account Service and new DB Table
      • Plaid
        • Plaid Configuration
        • Application Creation
        • Custom Application
        • Configure Single or Multi Accounts
        • Security Settings
        • Verification of Environment Variables
        • API Endpoints
        • Resources
        • Integrations
          • Rize
      • MX
        • Env Configuration
        • API Endpoints
  • ๐Ÿ”Authentication
    • Auth0
      • Configuration
      • Protecting an endpoint
      • Email verification
      • API Reference
    • Twilio
      • 2FA
        • Verify Service Configuration
        • Verification Workflow
        • API Endpoints
  • ๐Ÿชช KYC
    • Persona
      • Configuration
      • Environment Variables
      • KYC Flow
  • โœ‰๏ธ Mailings
    • Sendgrid
      • Configuration
      • Environment Variables
      • Send Email with Attachments
  • ๐Ÿ†˜Supports
    • Zendesk
      • Configuration
      • API Endpoints
  • ๐Ÿ“ณNOTIFICATIONS
    • OneSignal
      • Schema
      • Setup
      • Environment Variables
      • API Endpoints
  • ๐Ÿ”Security
    • VGS
      • Configuration
      • Rize Route Configuration
      • VGS Vault Basics
      • VGS Show
  • ๐Ÿ–ฅ๏ธMONITORING
    • New Relic
      • Configuration
      • Interceptor
  • ๐Ÿง‘โ€๐Ÿ”งCONTENT ADMINISTRATOR
    • Notifications
    • Onboardings
      • DB Schema
      • Admin - API Endpoints
      • Client - API Endpoints
    • Documents
      • Document Category
      • Document
      • Client - API Endpoints
      • Admin - API Endpoints
    • App Versions
      • Device App Versions
      • API - Administrator
      • API - Client
  • ๐Ÿ’ตPayments
    • Stripe
      • Configuration
      • Customers
      • Sources
      • Authorization
      • Charges
      • API Endpoints
Powered by GitBook
On this page

Was this helpful?

  1. CONTENT ADMINISTRATOR
  2. Documents

Admin - API Endpoints

PreviousClient - API EndpointsNextApp Versions

Last updated 2 years ago

Was this helpful?

Only admins and super admins can use these endpoints.

๐Ÿง‘โ€๐Ÿ”ง
delete
Authorizations
Path parameters
idstringRequiredExample: 0466770d-4024-457c-92d5-fbe9022ee5b7
Responses
200
Successful Operation
application/json
ResponseanyExample: {"statusCode":200}
400
This error can occur because of an invalid value or because a value is required.
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
404
An error occurred while entering the information
application/json
delete
DELETE /admin/contents/documents/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "statusCode": 200
}
delete
Authorizations
Path parameters
idstringRequiredExample: 0466770d-4024-457c-92d5-fbe9022ee5b7
Responses
200
Successful Operation
application/json
ResponseanyExample: {"statusCode":200}
400
This error can occur because of an invalid value or because a value is required.
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
404
An error occurred while entering the information
application/json
delete
DELETE /admin/contents/document-categories/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
{
  "statusCode": 200
}
  • POST/admin/contents/documents
  • PUT/admin/contents/documents/{id}
  • DELETE/admin/contents/documents/{id}
  • POST/admin/contents/document-categories
  • PUT/admin/contents/document-categories/{id}
  • DELETE/admin/contents/document-categories/{id}
post
Authorizations
Body
namestringRequiredExample: privacyPolicy
titlestringRequiredExample: Privacy Policy
contentstringRequired

Base 64 of PDF or url

Example: https://www.helloiconic.com/privacy-policy
documentCategoryIdstringRequiredExample: 0466770d-4024-457c-92d5-fbe9022ee5b7
iconNamestringRequired

This icon should match with an existing icon in the frontend

Example: book-open
formatstring ยท enumRequiredExample: urlPossible values:
expirationTimenumberRequired

This value is in ms. This value is the expiration time of the presigned url. Default is 23 hours for PDFs, and is null for URLs and public documents

Example: 36000
isPublicbooleanRequired

Public documents can be seen by anyone. Private documents can only be seen by logged in users. Default is false.

Example: true
Responses
201
Successful Operation
application/json
ResponseanyExample: {"statusCode":201}
400
This error can occur because of an invalid value or because a value is required.
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
404
An error occurred while entering the information
application/json
409
Failed because it already exists a document with this name in this category.
application/json
post
POST /admin/contents/documents HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "name": "privacyPolicy",
  "title": "Privacy Policy",
  "content": "https://www.helloiconic.com/privacy-policy",
  "documentCategoryId": "0466770d-4024-457c-92d5-fbe9022ee5b7",
  "iconName": "book-open",
  "format": "url",
  "expirationTime": 36000,
  "isPublic": true
}
{
  "statusCode": 201
}
put
Authorizations
Path parameters
idstringRequiredExample: 0466770d-4024-457c-92d5-fbe9022ee5b7
Body
namestringOptionalExample: termsAndConditions
titlestringOptionalExample: Terms & Conditions
contentstringOptional

Base 64 of PDF or url

Example: https://www.helloiconic.com/privacy-policy
documentCategoryIdstringOptionalExample: 0466770d-4024-457c-92d5-fbe9022ee5b7
iconNamestringOptional

This icon should match with an existing icon in the frontend

Example: book-open
indexnumberOptional

This is the order that will be returned to the frontend

Example: 5
formatstring ยท enumOptionalExample: urlPossible values:
expirationTimenumberOptional

This value is in ms. This value is the expiration time of the presigned url. Default is 23 hours for PDFs, and is null for URLs and public documents

Example: 36000
isPublicbooleanOptional

Public documents can be seen by anyone. Private documents can only be seen by logged in users. Default is false.

Example: true
Responses
200
Successful Operation
application/json
ResponseanyExample: {"statusCode":200}
400
This error can occur because of an invalid value or because a value is required.
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
404
An error occurred while entering the information
application/json
409
Failed because it already exists a document with this name in this category.
application/json
put
PUT /admin/contents/documents/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 260

{
  "name": "termsAndConditions",
  "title": "Terms & Conditions",
  "content": "https://www.helloiconic.com/privacy-policy",
  "documentCategoryId": "0466770d-4024-457c-92d5-fbe9022ee5b7",
  "iconName": "book-open",
  "index": 5,
  "format": "url",
  "expirationTime": 36000,
  "isPublic": true
}
{
  "statusCode": 200
}
post
Authorizations
Body
namestringRequiredExample: settings
Responses
201
Successful Operation
application/json
ResponseanyExample: {"statusCode":201}
400
This error can occur because of an invalid value or because a value is required.
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
404
An error occurred while entering the information
application/json
409
Failed because it already exists a document category with this name.
application/json
post
POST /admin/contents/document-categories HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "name": "settings"
}
{
  "statusCode": 201
}
put
Authorizations
Path parameters
idstringRequiredExample: 0466770d-4024-457c-92d5-fbe9022ee5b7
Body
namestringRequiredExample: settings
Responses
200
Successful Operation
application/json
ResponseanyExample: {"statusCode":200}
400
This error can occur because of an invalid value or because a value is required.
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
The token is correct but you need a specific role to access this endpoint
application/json
404
An error occurred while entering the information
application/json
409
Failed because it already exists a document category with this name.
application/json
put
PUT /admin/contents/document-categories/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "name": "settings"
}
{
  "statusCode": 200
}