API Reference

Onboarding Client KYB via API

To ensure a smoother and faster onboarding process, Paystrator automatically pushes KYB data to the provider's endpoint as soon as a client clicks “On Board” in the Marketplace.

It is highly recommended that providers implement this API integration to streamline onboarding. With this approach, providers can eliminate up to 75% of the manual steps typically required—accelerating KYB validation, document intake, and technical alignment.

🤝 Roles & Responsibilities

Paystrator handles:

  • Data collection from clients
  • KYB completeness check
  • Automatic data transmission to the provider
  • Generation of a unique reference_id to track the onboarding process

Providers are responsible for:

  • Exposing a secure endpoint to receive KYB data
  • Processing and validating the KYB information internally
  • Updating Paystrator on onboarding status (received, processing, approved, rejected, connected)
  • Completing endpoint testing once KYB is approved

📤 Example Payload

{
  "reference_id": "paystrator-kyb-90210", //generated by Paystrator
  "submitter": {
    "email": "[email protected]",
    "name": "John Doe",
  },
  "product_selection":"QR Code, Open VA, Close VA",
	"legal_entity": {
    "legal_name": "PT SANDBOX COMPANY",
    "brand_name": "Sanbox",
    "nib_number": "234234234234234",
    "country": "Indonesia",
    "company_type": "PT",
    "company_industry": [
      "Agriculture",
      "General E-commerce"
		],
    "address": {
      "full_address": "Jl. Belokan Bawah I No.11, Tamban",
      "province": "Banten",
      "city": "Tangerang Selatan",
      "district": "Serpong",
      "sub_district": "Buaran",
      "postal_code": "55581"
    },
    "phone": "+62918237123",
    "website": "http://kolaborasibersama.id"
  },
  "documents": {
    "nib_document": "https://.../nib.pdf",
    "npwp_number": "234234234234234",
    "npwp_document": "https://.../npwp.pdf",
    "proof_of_address": "https://.../address.pdf",
    "deed_of_establishment": "https://.../deed.pdf",
    "legal_certification": "https://.../legalcert.pdf",
    "additional_documents":
			[{
        filename:"1238790812739870",
				name:"sertifikasi iso 27000",
        file_url:"https://.../sertifikasi_iso_27000.pdf"
      },
				{
        filename:"1238790812739871",  
				name:"Best consumer awards 2049",
        file_url:"https://.../best_consumer_awards_2049.pdf"
			}]
  },
  "stakeholder": [{
    "director_name": "John Doe",
    "email": "[email protected]",
    "phone": "+628127756464",
    "birth_place": "Jakarta Timur",
    "birth_date": "1988-10-23",
    "occupation": "Entrepreneur",
    "address": "Jl. Basuki Rahmat No.1A, Blok G3A",
    "province": "DKI Jakarta",
    "city": "Jakarta Timur",
    "ktp_document": "https://.../ktp.jpg",
    "selfie_with_ktp": "https://.../selfie.jpg"
  }],
  "supporting": {
    "company_structure": "https://.../structure.pdf",
    "bank_account_proof": "https://.../bankbook.pdf",
    "business_location_photo": [
      "https://.../location1.jpg",
      "https://.../location2.jpg"
		],
    "power_of_attorney": "https://.../poa.pdf",
    "skt_sppkp": "https://.../skt.pdf"
  },
  "business_info": {
    "monthly_revenue": 100000000,
    "monthly_profit": 120000000,
    "ownership_status": "1",
    "operating_open_hour": "00:00",
		"operating_close_hour": "23:59"
  }
}

🆔 What is reference_id?

  • reference_id is a unique identifier generated by Paystrator each time a client starts the onboarding process.
  • It is used to track and monitor the onboarding flow across both systems (Paystrator and Provider).
  • Providers must include this reference_id when sending onboarding status updates via the Status Update API.

Field-Level Breakdown

FieldDescription
reference_idUnique identifier generated by Paystrator

submitter

FieldDescription
emailEmail of the submitter, usually used as account registration information
nameThe name of the submitter, usually used as account registration information

legal_entity

Field

Description

legal_name

Official registered company name

brand_name

Commercial name used in customer-facing channels

nib_number

Nomor Induk Berusaha (Business Registration Number)

country

Country of registration (currently only support 'Indonesia')

company_type

Type of legal entity, supported company types:

  1. PT (Private Limited Company)
  2. TBK (Public Company)
  3. CV (Registered Partnership Establishment)
  4. Firm
  5. Koperasi (Cooperative)
  6. Lembaga Pemerintah (Goverment Institution)
  7. BUMN (State-owned Enterprise)
  8. BUMD (Regional Owned Enterprise)
  9. Other
  10. PT Perorangan (Individual Limited Company)
  11. Yayasan (Foundation)
  12. My business has no legal entity yet

company_industry

Primary business type, can be many. Array of strings. See the end of this document for full company industry.

address.*

Full address split into province, city, district, sub-district, and postal code

phone

Company phone number

website

Company website

Address

coming soon: we're providing API to get list of province, city, district,and sub_district

FieldDescription
full_addressClient's full address
provinceClient's province
cityClient's city (kota/kabupaten)
districtClient's district (kecamatan)
sub_districtClient's sub district (kelurahan/desa)
postal_codeClient's postal code

documents

FieldDescription
nib_documentLink to scanned NIB certificate
npwp_numberCompany NPWP number
npwp_documentScanned NPWP document
proof_of_addressUtility bill or other proof of business address
deed_of_establishmentCompany deed (Akta Pendirian)
legal_certificationCertificate from Kemenkumham
additional_documents.*other additional documents, such as business license, certifications, etc.

additional_documents

FieldDescription
filenameunique file ID
namethe name of the file
file_urlthe url of the document

👤 stakeholder

FieldDescription
director_nameFull name of the company director
emailDirector’s email
phoneDirector’s phone number
birth_placePlace of birth
birth_dateDate of birth (YYYY-MM-DD)
occupationDirector’s current occupation
addressDirector’s residential address
provinceLocation of residence
cityLocation of residence
ktp_documentScanned copy of KTP
selfie_with_ktpSelfie holding KTP

📁 supporting

FieldDescription
company_structureorg chart (optional)
bank_account_proofFirst page of company bank book
business_location_photoPhysical photos of business premises (array of URL)
power_of_attorneyLetter of authority (if applicable)
skt_sppkpSKT/SPPKP tax certificate (optional)

business_info

FieldDescription
monthly_revenueEstimated monthly revenue in Rupiah
monthly_profitEstimated monthly profit in Rupiah
ownership_status“Rent” or “Owned” status of business premises
operating_hoursDaily operating hours (e.g., 00:00 - 23:59)

✅ Expected Response from Provider

{
  "reference_id": "paystrator-kyb-90210",
  "status": "received",
  "reamrks": ""//optional, for need_revision and rejected status
}
  • reference_id will be used for status updates.
  • Must respond with HTTP 200 OK.

📊 Status Lifecycle Using reference_id

StatusMeaning
receivedProvider has successfully received the KYB payload from Paystrator
processingKYB data is under internal review by the provider
approvedKYB has been verified and accepted by the provider
need_revisionKYB need revision from client side (include reason in remarks)
rejectedKYB has been rejected (include reason in remarks)

All status updates must reference the original reference_id.

Company Industry List

  • General E-commerce
  • Fashion E-commerce
  • Grocery E-commerce
  • Electronics E-commerce
  • Luxury E-commerce
  • Second-hand E-commerce
  • B2B E-commerce
  • Social Commerce
  • Subscription E-commerce
  • SaaS
  • IaaS
  • PaaS
  • Cybersecurity
  • API Services
  • Web Development
  • Design Tools
  • Digital Banking
  • Digital Payments
  • Digital Lending
  • Insurtech
  • Wealth Management
  • Cryptocurrency
  • Remittance
  • Financial Comparison
  • Online Courses
  • Language Learning
  • Skill Development
  • Tutoring
  • Test Preparation
  • Early Childhood
  • Corporate Training
  • Educational Content
  • EdTech Tools
  • Virtual Reality Education
  • Telemedicine
  • E-pharmacy
  • Mental Health
  • Fitness Tech
  • Nutrition
  • Health Monitoring
  • Medical Records
  • Wellness Content
  • Digital Diagnostics
  • Senior Care Tech
  • Ride-hailing
  • Food Delivery
  • Grocery Delivery
  • Home Services
  • Beauty Services
  • Freelance Services
  • Logistics
  • Parking
  • Car Washing
  • Fuel Delivery
  • Video Streaming
  • Music Streaming
  • Podcasting
  • Digital Publishing
  • Online Gaming
  • Esports
  • Virtual Events
  • Social Media
  • Digital Art
  • Augmented Reality
  • Programmatic Advertising
  • Influencer Marketing
  • Email Marketing
  • SEO Tools
  • Social Media Management
  • Content Marketing
  • Affiliate Marketing
  • Marketing Analytics
  • Conversational Marketing
  • Video Marketing
  • Accommodation Sharing
  • Car Sharing
  • Bike Sharing
  • Co-working Spaces
  • Storage Sharing
  • Equipment Sharing
  • Skill Sharing
  • Delivery Crowdsourcing
  • WiFi Sharing
  • Pet Sitting
  • Smart Home
  • Industrial IoT
  • Wearable Tech
  • Smart City
  • Connected Cars
  • IoT Security
  • Smart Retail
  • Smart Agriculture
  • IoT Platforms
  • Smart Energy
  • AI Software
  • Machine Learning
  • Natural Language Processing
  • Computer Vision
  • Predictive Analytics
  • Big Data
  • AI Chatbots
  • AI in Healthcare
  • AI in Finance
  • Data Visualization
  • Food and Beverage
  • General Retail
  • Hospitality
  • Tourism
  • Personal Care
  • Fashion and Apparel
  • Electronics
  • Automotive
  • Home and Garden
  • Entertainment
  • Pet Care
  • Art and Craft
  • Sports and Recreation
  • Passenger Transport
  • Freight
  • Education
  • Financial Services
  • Legal Services
  • Creative Services
  • Real Estate
  • Design Services
  • Agriculture Consulting
  • Retail Energy
  • Renewable Energy
  • Waste Management
  • Water Services
  • Wholesale
  • Supply Chain
  • Food Service
  • Hospitality Supplies
  • Marketing
  • Apparel Wholesale
  • Medical Supplies
  • Pharmaceutical
  • Fitness Equipment
  • Educational Supplies
  • Agricultural Supplies
  • Food Processing
  • Beverage Production
  • Textiles
  • Apparel
  • IT Services
  • Telecom Equipment
  • Software
  • EdTech