Skip to main content

​
Getting your API key

  1. Log in to app.matproof.com
  2. Go to Settings → API Keys
  3. Click Create API key
  4. Copy and store your key securely — it won’t be shown again

​
Using your API key

Pass your API key in the Authorization header: 
curl https://api.matproof.com/v1/vendors \
  -H "Authorization: Bearer YOUR_API_KEY"

​
API key scopes

When creating an API key, select the required scopes:
ScopeAccess
read:vendorsList and read vendor data
write:vendorsCreate and update vendors
read:evidenceRead evidence files
write:evidenceUpload evidence
read:controlsRead control status
write:controlsUpdate control status
read:risksRead risk register
write:risksCreate and update risks
read:csrdRead CSRD/ESG data
write:csrdSubmit ESG data

​
Security best practices

  • Store API keys in environment variables, never in code
  • Use the minimum required scopes
  • Rotate keys regularly
  • Delete keys you’re no longer using
  • Use separate keys for different applications

​
Error responses

StatusMeaning
401 UnauthorizedMissing or invalid API key
403 ForbiddenValid key but insufficient scope
429 Too Many RequestsRate limit exceeded