{ "opencollection": "1.0.0", "info": { "name": "Mosey Accounts API", "version": "1.0.0" }, "items": [ { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Embedded Signup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/accounts/signup", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "verbose", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Embedded Signup" }, { "info": { "name": "Create Hosted Signup Session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/accounts/signup/sessions", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "verbose", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Provides a URL for directing a user through the hosted signup experience. Upon successful completion the user will be redirected to the callback_url. The returned legal entity id will not be active until the user has completed their signup. If a subsequent signup needs to be generated for a user the returned legal_entity_id from the first should be included in the request." }, { "info": { "name": "Authenticate Legal Entity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/accounts/auth", "headers": [ { "name": "authorization", "value": "" } ], "params": [ { "name": "verbose", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Provides a short-lived authentication token scoped to the requested legal entity. Tokens must be included as an Authorization header for all API requests on behalf of the legal entity. They are valid for 10 minutes. Your API key will be provided to you by Mosey." }, { "info": { "name": "Connect Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/accounts/connect", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "resource_owner_password_credentials", "accessTokenUrl": "/api/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a hosted connection URL, which allows the user to connect to a specific account in the state agency such as accessing Employer Services Online Account in California Employment Development Department. This endpoint returns the connection_id which can be used to query the current status of the connection." }, { "info": { "name": "Get Account Connection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/accounts/connections/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "resource_owner_password_credentials", "accessTokenUrl": "/api/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the current status of connection. The statuses can be - Pending/Authenticating/Registering/Connected/Disconnected/Canceled." }, { "info": { "name": "Cancel Account Connection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/accounts/connections/:connection_id/cancel", "params": [ { "name": "connection_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "resource_owner_password_credentials", "accessTokenUrl": "/api/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancels a pending, registering, or authenticating connection for the given connection_id." }, { "info": { "name": "Create Agency Accounts Management Session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/accounts/manage/session", "params": [ { "name": "legal_entity_public_id", "value": "", "type": "query" }, { "name": "user_or_platform_public_id", "value": "", "type": "query" }, { "name": "platform_public_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "resource_owner_password_credentials", "accessTokenUrl": "/api/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an authenticated session to enter the Mosey app, and returns\nthe url on which a user can view accounts registered with state agencies and login credentials if present with state agencies.\n\nThe list of agencies supported can be viewed at /v2/agency_accounts" } ] } ], "bundled": true }