Account types API3

Accounting4

Accounts API3

Application Providers API5

Applications API5

Asset Rates API1

Assets API3

Audit API3

Authentication API3

Authorization API1

Balances API3

Billing Calculation API1

Billing Packages API3

Catalog API11

Configuration11

Configuration Contexts5

Configuration Fee Rules5

Configuration Fee Schedules6

Configuration Field Maps4

Configuration Match Rules6

Configuration Schedules5

Configuration Sources4

Consignado1

Dashboard2

Dashboard API2

Discovery20

Estimation API1

Exception26

Executions API4

Executor Configurations API4

Export Jobs6

Fetcher2

Governance11

Groups API2

Holders API5

Ingestion21

Instruments API4

Jurisdictions2

Ledgers API3

Loan Accounts17

Loan Applications1

LoanApplications6

LoanProducts13

Matching14

Metadata Indexes API3

MFA API8

Operation routes API3

Operations API1

Organizations API3

Packages API3

Portfolios API3

Protection API1

Provider Configurations API8

Providers API5

Reporting20

Segments API3

Servicings4

Tax1

Transaction routes API3

Transactions API9

User Information API2

Users API7

Webhooks API5

Workflows API10

Providers API

Create a Provider

Use this endpoint to register a new communication provider (email or SMS) for use in authentication and notification flows.

post/v1/providers

Request

Base URL
https://identity.sandbox.lerian.net
Auth
HTTP bearer
TypeScript
https://skmtc.dev/lerian/apis/identity-plugin/docs/v1/providers/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

A unique name to identify the provider.

category'Email' | 'SMS' required

The provider category.

type'SendGrid' | 'Twilio' required

The provider implementation type.

subTypestring

Provider sub-type, if applicable.

methodstring

Authentication or delivery method.

clientIdstring

Client ID or API key for authenticating with the provider.

clientSecretstring

Client secret or API secret for authenticating with the provider.

clientId2string

Secondary client ID, if applicable.

clientSecret2string

Secondary client secret, if applicable.

hoststring

SMTP or API host address (Email providers).

portinteger

SMTP port (Email providers).

disableSslboolean

Set to true to disable SSL/TLS (not recommended for production).

titlestring

Default email or SMS title/subject.

contentstring

Default message content template.

receiverstring

Default receiver address for testing.

regionIdstring

Cloud region ID (provider-specific).

signNamestring

SMS signature name (provider-specific).

templateCodestring

SMS template code (provider-specific).

appIdstring

Application ID (provider-specific).

endpointstring

Provider API endpoint URL.

intranetEndpointstring

Intranet endpoint for private network access.

domainstring

Provider domain.

Response

Indicates that the provider was successfully created and the operation was completed as expected.

idstring

Unique identifier of the provider.

namestring

Name of the provider.

category'Email' | 'SMS'

Provider category.

type'SendGrid' | 'Twilio'

Provider implementation type.