-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathatomic-fi.opencollection.json
More file actions
154 lines (154 loc) · 8.6 KB
/
Copy pathatomic-fi.opencollection.json
File metadata and controls
154 lines (154 loc) · 8.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
{
"opencollection": "1.0.0",
"info": {
"name": "Atomic API",
"version": "1.0"
},
"request": {
"auth": {
"type": "apikey",
"apikey": [
{ "key": "key", "value": "x-api-key" },
{ "key": "value", "value": "{{apiKey}}" },
{ "key": "in", "value": "header" }
]
}
},
"items": [
{
"info": { "name": "Access Tokens", "type": "folder" },
"items": [
{
"info": { "name": "Create an access token", "type": "http" },
"http": {
"method": "POST",
"url": "https://api.atomicfi.com/access-token",
"body": { "type": "json", "data": "{\n \"identifier\": \"<string>\",\n \"tokenLifetime\": 86400\n}" }
},
"docs": "Exchanges your API Key and Secret for a publicToken used to initialize the Transact SDK."
},
{
"info": { "name": "Revoke an access token", "type": "http" },
"http": {
"method": "PUT",
"url": "https://api.atomicfi.com/access-token/:publicToken/revoke"
},
"docs": "Invalidates an existing publicToken."
}
]
},
{
"info": { "name": "Company", "type": "folder" },
"items": [
{
"info": { "name": "Search companies", "type": "http" },
"http": {
"method": "POST",
"url": "https://api.atomicfi.com/company/search",
"body": { "type": "json", "data": "{\n \"query\": \"<string>\",\n \"product\": \"deposit\",\n \"scopes\": [\"user-link\"]\n}" }
},
"docs": "Find employers or merchants supported for a product."
},
{
"info": { "name": "List companies", "type": "http" },
"http": {
"method": "GET",
"url": "https://api.atomicfi.com/company/list?product=deposit&scope=user-link&limit=100&skip=0"
},
"docs": "List companies matching filters."
},
{
"info": { "name": "Get company details", "type": "http" },
"http": {
"method": "GET",
"url": "https://api.atomicfi.com/company/:companyId/details"
},
"docs": "Full company metadata including connector capabilities."
}
]
},
{
"info": { "name": "Tasks", "type": "folder" },
"items": [
{
"info": { "name": "Get task details", "type": "http" },
"http": { "method": "GET", "url": "https://api.atomicfi.com/task/:taskId/details" },
"docs": "Complete task object."
},
{
"info": { "name": "Get task status", "type": "http" },
"http": { "method": "GET", "url": "https://api.atomicfi.com/task/:taskId/status" },
"docs": "Task status: queued, processing, completed, or failed."
},
{
"info": { "name": "Generate file URL", "type": "http" },
"http": { "method": "GET", "url": "https://api.atomicfi.com/task/:taskId/file/:fileId/generate-url" },
"docs": "Presigned URL for a task-produced file."
},
{
"info": { "name": "Prescreen a task", "type": "http" },
"http": {
"method": "POST",
"url": "https://api.atomicfi.com/task/prescreen",
"body": { "type": "json", "data": "{\n \"company\": { \"name\": \"<string>\" },\n \"product\": \"verify\"\n}" }
},
"docs": "Confidence signal on whether a company can be connected (beta)."
},
{
"info": { "name": "Start task workflow from linked account", "type": "http" },
"http": {
"method": "POST",
"url": "https://api.atomicfi.com/task-workflow/from-linked-account",
"body": { "type": "json", "data": "{\n \"linkedAccount\": \"<string>\",\n \"tasks\": [\n { \"operation\": \"deposit\", \"onComplete\": \"finish\", \"distribution\": { \"type\": \"total\", \"amount\": 100 } }\n ]\n}" }
},
"docs": "Run tasks against an already-connected linked account."
}
]
},
{
"info": { "name": "Data", "type": "folder" },
"items": [
{ "info": { "name": "Get deposit accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/deposit-accounts/:identifier" }, "docs": "Deposit accounts on file." },
{ "info": { "name": "Get employment", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/employment/:identifier" }, "docs": "Employment data." },
{ "info": { "name": "Get identity", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/identity/:identifier" }, "docs": "Identity data." },
{ "info": { "name": "Get income", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/income/:identifier" }, "docs": "Income data." },
{ "info": { "name": "Get statements", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/statements/:identifier?limit=10" }, "docs": "Paystubs." },
{ "info": { "name": "Get timesheets", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/timesheets/:identifier" }, "docs": "Timesheets." },
{ "info": { "name": "Get taxes", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/taxes/:identifier" }, "docs": "W-2 / 1099 tax forms." },
{ "info": { "name": "List linked accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/linked-account/list/:identifier" }, "docs": "Connected linked accounts for a user." }
]
},
{
"info": { "name": "PayLink", "type": "folder" },
"items": [
{ "info": { "name": "Actions for company", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/pay-link/actions-for-company/:companyId" }, "docs": "Available PayLink actions for a merchant." },
{ "info": { "name": "Get accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/pay-link/accounts" }, "docs": "User's connected PayLink accounts." }
]
},
{
"info": { "name": "Users", "type": "folder" },
"items": [
{ "info": { "name": "Update user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atomicfi.com/user", "body": { "type": "json", "data": "{\n \"identifier\": \"<string>\",\n \"data\": { \"bankAccounts\": [], \"cards\": [] }\n}" } }, "docs": "Store destination bank accounts or cards for a task workflow." },
{ "info": { "name": "Get user tasks", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/user/:identifier/tasks?status=completed&payrollDataAvailable=true" }, "docs": "Tasks for a user." },
{ "info": { "name": "End monitoring", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atomicfi.com/user/:identifier/end-monitoring" }, "docs": "Stop monitoring a user's linked accounts." }
]
},
{
"info": { "name": "Webhooks", "type": "folder" },
"items": [
{ "info": { "name": "List webhook endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/webhooks/endpoints" }, "docs": "List webhook endpoints." },
{ "info": { "name": "Create webhook endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.atomicfi.com/webhooks/endpoints", "body": { "type": "json", "data": "{\n \"url\": \"https://your-endpoint.com/webhooks\",\n \"secretId\": \"<string>\",\n \"eventTypes\": [\"task-status-updated\"]\n}" } }, "docs": "Create a webhook endpoint." },
{ "info": { "name": "Update webhook endpoint", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atomicfi.com/webhooks/endpoints/:id" }, "docs": "Update a webhook endpoint." },
{ "info": { "name": "Delete webhook endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atomicfi.com/webhooks/endpoints/:id" }, "docs": "Delete a webhook endpoint." }
]
},
{
"info": { "name": "Secrets", "type": "folder" },
"items": [
{ "info": { "name": "List secrets", "type": "http" }, "http": { "method": "GET", "url": "https://api.atomicfi.com/secrets" }, "docs": "List signing secrets." },
{ "info": { "name": "Create secret", "type": "http" }, "http": { "method": "POST", "url": "https://api.atomicfi.com/secrets", "body": { "type": "json", "data": "{\n \"name\": \"<string>\"\n}" } }, "docs": "Create a signing secret." },
{ "info": { "name": "Delete secret", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atomicfi.com/secrets/:id" }, "docs": "Delete a signing secret." }
]
}
]
}