{"items":[{"type":"link","label":"Referral API","link":"/apis/referral-api-v1","routeSlug":"/apis/referral-api-v1","content":{"contentType":"overview","meta":{"name":"Referral API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"referral-api-v1.json","url":"/_bundle/apis/referral-api-v1.json?download"},{"kind":"download","label":"referral-api-v1.yaml","url":"/_bundle/apis/referral-api-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary — © RAI Partners Inc. All rights reserved.","url":"https://www.raipartners.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/referral-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Referral API (1.0.8)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RAI Partners Referral API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API version 1.0.8 is scheduled for deprecation on 2027-07-01."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It will continue to function until then; please migrate to 2.x.x."},"children":[]}]}]}]}],"sectionId":"/apis/referral-api-v1"}],"sectionId":"/apis/referral-api-v1"}]}]}},{"type":"group","label":"Referral","link":"/apis/referral-api-v1/referral","routeSlug":"/apis/referral-api-v1/referral","items":[{"label":"Create an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/referral-api-v1/referral/createapplication","routeSlug":"/apis/referral-api-v1/referral/createapplication","metadata":{"seo":{"title":"Create an application","description":"Create an application with the provided data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplication","name":"Create an application","isWebhook":false,"pointer":"/paths/~1application~1{product-id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an application with the provided data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-jwt","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"product-id","in":"path","schemaId":"schema_10","description":"The product id provided by RAI.","required":true}],"pointer":"/paths/~1application~1{product-id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"API-Version","in":"header","schemaId":"schema_11"}],"pointer":"/paths/~1application~1{product-id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application","pointer":"/paths/~1application~1{product-id}/post/requestBody","description":"The information to use for the application."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/application/{product-id}","servers":[{"url":"/_mock/apis/referral-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}],"parameters":{"path":[{"name":"product-id","in":"path","required":true,"schemaId":"schema_10"}],"query":[],"querystring":[],"header":[{"name":"API-Version","in":"header","schemaId":"schema_11"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-jwt","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Application"}},"responseCodes":["200","400","404","500","503"],"pointer":"/application/{product-id}","href":"referral/createapplication","openApiOperationId":"createApplication","summary":"Create an application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/referral-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}],"schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Application"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application was handled successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReply"}},"schemaId":"components/schemas/ApplicationReply"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic missing data"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic missing data"]},{"code":"404","description":"not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/404/content/application~1json/examples/Not found"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/500/content/application~1json/examples/Internal server error"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/500/content/application~1json/examples/Internal server error"]},{"code":"503","description":"Service unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/503/content/application~1json/examples/Service unavailable"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/503/content/application~1json/examples/Service unavailable"]}],"pointer":"/paths/~1application~1{product-id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationReply","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReply"}}},{"code":"400","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic missing data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic missing data"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"500","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/500/content/application~1json/examples/Internal server error"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/503/content/application~1json/examples/Service unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1application~1{product-id}/post/responses/503/content/application~1json/examples/Service unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/referral/createapplication"}],"panels":[]}]},"httpPath":"/application/{product-id}"},{"label":"Get spousal notification states","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/referral-api-v1/referral/getspousalnotificationstates","routeSlug":"/apis/referral-api-v1/referral/getspousalnotificationstates","metadata":{"seo":{"title":"Get spousal notification states","description":"Retrieve the list of US States requiring spousal notifications"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSpousalNotificationStates","name":"Get spousal notification states","isWebhook":false,"pointer":"/paths/~1spousal-notification-states/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get spousal notification states","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the list of US States requiring spousal notifications"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-jwt","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"API-Version","in":"header","schemaId":"schema_11"}],"pointer":"/paths/~1spousal-notification-states/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/spousal-notification-states","servers":[{"url":"/_mock/apis/referral-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"API-Version","in":"header","schemaId":"schema_11"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-jwt","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500","503"],"pointer":"/spousal-notification-states","href":"referral/getspousalnotificationstates","openApiOperationId":"getSpousalNotificationStates","summary":"Get spousal notification states"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/referral-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of states in 2 characters abbreviated form.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic invalid data","paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic missing data"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic invalid data","paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic missing data"]},{"code":"404","description":"not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/404/content/application~1json/examples/Not found"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/500/content/application~1json/examples/Internal server error"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/500/content/application~1json/examples/Internal server error"]},{"code":"503","description":"Service unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/503/content/application~1json/examples/Service unavailable"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/503/content/application~1json/examples/Service unavailable"]}],"pointer":"/paths/~1spousal-notification-states/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"400","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic invalid data","paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic missing data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic invalid data","paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic missing data"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"500","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/500/content/application~1json/examples/Internal server error"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/503/content/application~1json/examples/Service unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1spousal-notification-states/get/responses/503/content/application~1json/examples/Service unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/referral/getspousalnotificationstates"}],"panels":[]}]},"httpPath":"/spousal-notification-states"}],"content":{"contentType":"group","meta":{"name":"Referral"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Referral","showPageActions":true},{"nodeType":"markdoc","content":"Referral functions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/application/{product-id}","summary":"Create an application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/referral/createapplication","deprecated":false},{"title":"/spousal-notification-states","summary":"Get spousal notification states","prefix":{"name":"get","color":"get"},"badges":[],"link":"/referral/getspousalnotificationstates","deprecated":false}]}]}]}]}},{"type":"group","label":"Authentication","link":"/apis/referral-api-v1/authentication","routeSlug":"/apis/referral-api-v1/authentication","items":[{"label":"Rotate the client secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/referral-api-v1/authentication/rotateclientsecret","routeSlug":"/apis/referral-api-v1/authentication/rotateclientsecret","metadata":{"seo":{"title":"Rotate the client secret","description":"Rotate and returns the client secret"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rotateClientSecret","name":"Rotate the client secret","isWebhook":false,"pointer":"/paths/~1auth~1client-secret~1rotation/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate the client secret","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Rotate and returns the client secret"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-jwt","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"API-Version","in":"header","schemaId":"schema_11"}],"pointer":"/paths/~1auth~1client-secret~1rotation/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/client-secret/rotation","servers":[{"url":"/_mock/apis/referral-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"API-Version","in":"header","schemaId":"schema_11"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-jwt","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500","503"],"pointer":"/auth/client-secret/rotation","href":"authentication/rotateclientsecret","openApiOperationId":"rotateClientSecret","summary":"Rotate the client secret"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/referral-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The rotated secret.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RotatedSecret"}},"schemaId":"components/schemas/RotatedSecret"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"]},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"]},{"code":"403","description":"Forbidden.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"]},{"code":"404","description":"not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"]},{"code":"503","description":"Service unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"]}],"pointer":"/paths/~1auth~1client-secret~1rotation/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RotatedSecret","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RotatedSecret"}}},{"code":"400","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"]}}},{"code":"401","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"500","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/rotateclientsecret"}],"panels":[]}]},"httpPath":"/auth/client-secret/rotation"},{"label":"Authenticate client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/referral-api-v1/authentication/authenticateclient","routeSlug":"/apis/referral-api-v1/authentication/authenticateclient","metadata":{"seo":{"title":"Authenticate client","description":"Authenticate a client and retrieve the JWT token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticateClient","name":"Authenticate client","isWebhook":false,"pointer":"/paths/~1auth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticate client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Authenticate a client and retrieve the JWT token"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"API-Version","in":"header","schemaId":"schema_11"}],"pointer":"/paths/~1auth~1token/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientTokenRequest"}},"schemaId":"components/schemas/ClientTokenRequest","pointer":"/paths/~1auth~1token/post/requestBody","description":"The client credentials."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth/token","servers":[{"url":"/_mock/apis/referral-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"API-Version","in":"header","schemaId":"schema_11"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ClientTokenRequest"}},"responseCodes":["200","400","404","500","503"],"pointer":"/auth/token","href":"authentication/authenticateclient","openApiOperationId":"authenticateClient","summary":"Authenticate client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/referral-api-v1","description":"Mock server","isMockServer":true},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}],"schemaId":"components/schemas/ClientTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClientTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The JWT token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JWTClientTokenResponse"}},"schemaId":"components/schemas/JWTClientTokenResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"]},{"code":"404","description":"not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"]},{"code":"500","description":"Internal Server Error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"]},{"code":"503","description":"Service unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"]}},"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"]}],"pointer":"/paths/~1auth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/JWTClientTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JWTClientTokenResponse"}}},{"code":"400","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data","paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"]}}},{"code":"404","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"500","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProblemDetail","exampleIds":["paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/authenticateclient"}],"panels":[]}]},"httpPath":"/auth/token"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":"Authentication functions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth/client-secret/rotation","summary":"Rotate the client secret","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/rotateclientsecret","deprecated":false},{"title":"/auth/token","summary":"Authenticate client","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/authenticateclient","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Applicant":{"id":"components/schemas/Applicant","kind":"json-schema","title":"Applicant","data":{"type":"object","properties":{"identity":{"$ref":"#/components/schemas/Person","description":"The person applying."},"email":{"type":"string","description":"The person's email.","example":"myemail@email.com"},"phoneNumber":{"type":"string","description":"10 digits phone number.","example":"1234567890","pattern":"\\d{10}"},"address":{"$ref":"#/components/schemas/Address","description":"The person's address."},"income":{"$ref":"#/components/schemas/Income","description":"The applicant's income information."},"expenses":{"$ref":"#/components/schemas/Expenses","description":"The applicant's expense information."},"maritalStatus":{"type":["string","null"],"default":"NotMarried","description":"The applicant's optional marital status.","enum":["Married","NotMarried"],"example":"NotMarried"}},"required":["address","email","expenses","identity","income","phoneNumber"]}},"components/schemas/Application":{"id":"components/schemas/Application","kind":"json-schema","title":"Application","data":{"type":"object","properties":{"applicant":{"$ref":"#/components/schemas/Applicant","description":"The information of the person applying."},"spouse":{"oneOf":[{"$ref":"#/components/schemas/SpouseInformation"},{"type":"null"}]},"consents":{"$ref":"#/components/schemas/Consents","description":"The applicant's various consents."},"metadata":{"oneOf":[{"$ref":"#/components/schemas/Metadata"},{"type":"null"}]}},"required":["applicant","consents"]}},"components/schemas/ClearSSN":{"id":"components/schemas/ClearSSN","kind":"json-schema","title":"ClearSSN","data":{"description":"9 digits social security number.","example":123456789,"pattern":"\\d{9}"}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"type":"object","properties":{"first":{"type":"string","example":"John","pattern":"^(?! )(?![ '.-])[\\w\\s./'-]{1,29}(?<! )(?<!-)$"},"last":{"type":"string","example":"Smith","pattern":"^(?! )(?![ '.-])[\\w\\s./'-]{1,29}(?<! )(?<!-)$"},"middle":{"type":["string","null"],"example":"James","pattern":"^(?! )(?![ '.-])[\\w\\s./'-]{1,29}(?<! )(?<!-)$"}},"required":["first","last"]}},"components/schemas/Person":{"id":"components/schemas/Person","kind":"json-schema","title":"Person","data":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Name","description":"The person's name."},"birthDate":{"type":"string","format":"date","description":"The person's date of birth.","example":"2000-01-31"},"socialSecurityNumber":{"type":"string","description":"Either a clear 9-digit SSN or an encrypted string","oneOf":[{"$ref":"#/components/schemas/ClearSSN"},{"type":"string","description":"Encrypted social security number if you requested Encrypted SSN support.","example":"gAAAAABkX..."}]}},"required":["birthDate","name","socialSecurityNumber"]}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","properties":{"line1":{"type":"string","description":"The first line.","example":"1 Main St","pattern":"^(?=.*\\S).{1,26}$"},"line2":{"type":["string","null"],"description":"The optional second line.","example":"Apt 35","pattern":"^(?:[a-zA-Z0-9\\s\\-.\\/,#'']{0,26}|)$"},"city":{"type":"string","description":"The city name.","example":"Dallas","pattern":"\\b[A-Za-z0-9\\- ]{2,18}\\b"},"state":{"type":"string","description":"The state abbreviation.","example":"TX","pattern":"^[A-Z]{2}$"},"zipCode":{"type":"string","description":"The 5 digit zip code.","example":"75000","pattern":"^(\\d{5}(-\\d{4})?)|(\\d{9})$"}},"required":["city","line1","state","zipCode"]}},"components/schemas/Consents":{"id":"components/schemas/Consents","kind":"json-schema","title":"Consents","data":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/ContactPreferences","description":"Contact consents."},"shareDataWithFI":{"type":"boolean","description":"Consent to share data with the financial institution.","example":true},"softPull":{"type":"boolean","description":"Consent to perform a soft-pull from the credit bureau.","example":true}},"required":["contact","shareDataWithFI","softPull"]}},"components/schemas/ContactPreferences":{"id":"components/schemas/ContactPreferences","kind":"json-schema","title":"ContactPreferences","data":{"type":"object","properties":{"allowEmailContact":{"type":"boolean","description":"Consent to contact via email.","example":true},"allowPhoneContact":{"type":"boolean","description":"Consent to contact via phone.","example":true},"allowSmsContact":{"type":"boolean","description":"Consent to contact via SMS.","example":true}},"required":["allowEmailContact","allowPhoneContact","allowSmsContact"]}},"components/schemas/Expenses":{"id":"components/schemas/Expenses","kind":"json-schema","title":"Expenses","data":{"type":"object","properties":{"monthlyHousing":{"type":"integer","format":"int32","description":"The monthly housing expense (in whole US Dollar).","example":1000}},"required":["monthlyHousing"]}},"components/schemas/Income":{"id":"components/schemas/Income","kind":"json-schema","title":"Income","data":{"type":"object","properties":{"annualIncome":{"type":"integer","format":"int32","description":"The annual income (in whole US Dollar).","example":30000,"minimum":100},"source":{"type":"string","description":"The income source.","enum":["Employment","Inheritance","Trust","Investment","Retirement","SocialSecurity","Unemployment","Other"],"example":"Employment"}},"required":["annualIncome","source"]}},"components/schemas/Metadata":{"id":"components/schemas/Metadata","kind":"json-schema","title":"Metadata","data":{"type":"object","properties":{"membershipType":{"type":["string","null"],"description":"The membership type of the applicant.","enum":["Member","NonMember"],"example":"NonMember"},"referralChannel":{"type":["string","null"],"description":"The referral channel through which the applicant was referred.","enum":["Web","Branch","Phone","Other"],"example":"Branch"},"creditInquiry":{"type":["string","null"],"description":"The credit inquiry type for the applicant.","enum":["Soft","Hard"],"example":"Soft"}}}},"components/schemas/SpouseInformation":{"id":"components/schemas/SpouseInformation","kind":"json-schema","title":"SpouseInformation","data":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Name","description":"The person's name."},"email":{"type":"string","description":"The person's email.","example":"myemail@email.com"},"address":{"$ref":"#/components/schemas/Address","description":"The person's address."}},"required":["address","email","name"]}},"components/schemas/ApplicationReply":{"id":"components/schemas/ApplicationReply","kind":"json-schema","title":"ApplicationReply","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The application id.","example":"2bb04ce6-daeb-422b-b8fd-686aa09e2c88"},"url":{"type":"string","format":"uri","description":"The application url to redirect to.","example":"https://apply.groundworkcard.com/app/wizard/2bb04ce6-daeb-422b-b8fd-686aa09e2c88"},"status":{"type":"string","description":"The application status.","enum":["Pending","Approved","Declined"],"example":"Pending"}},"required":["id","status","url"]}},"components/schemas/ProblemDetail":{"id":"components/schemas/ProblemDetail","kind":"json-schema","title":"ProblemDetail","data":{"type":"object","properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"detail":{"type":"string"},"instance":{"type":"string","format":"uri"},"properties":{"type":"object","additionalProperties":{}}}}},"components/schemas/RotatedSecret":{"id":"components/schemas/RotatedSecret","kind":"json-schema","title":"RotatedSecret","data":{"type":"object","properties":{"secret":{"type":"string"}},"required":["secret"]}},"components/schemas/ClientTokenRequest":{"id":"components/schemas/ClientTokenRequest","kind":"json-schema","title":"ClientTokenRequest","data":{"type":"object","description":"A client token request payload","properties":{"client_id":{"type":"string","description":"The client ID to use for authentication","example":"my-client-id"},"client_secret":{"type":"string","description":"The client secret to use for authentication","example":"my-super-auth-secret"}},"required":["client_id","client_secret"]}},"components/schemas/JWTClientTokenResponse":{"id":"components/schemas/JWTClientTokenResponse","kind":"json-schema","title":"JWTClientTokenResponse","data":{"type":"object","properties":{"scope":{"type":"string","description":"The token scope as a space delimited set of values.","example":"read:user write:user"},"refresh_expires_in":{"type":"integer","format":"int32","description":"The refresh token expiry in seconds.","example":300},"access_token":{"type":"string","description":"The JWT token.","example":"eyo....."},"expires_in":{"type":"integer","format":"int32","description":"The token expiry in seconds.","example":300},"token_type":{"type":"string","description":"The token type.","example":"Bearer"},"not-before-policy":{"type":"integer","format":"int32","description":"The not before policy in seconds.","example":0}},"required":["access_token","expires_in","scope","token_type"]}},"schema_10":{"kind":"json-schema","data":{"type":"string"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string","enum":["1.0.8"]},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","example":"WI","pattern":"^[A-Z]{2}$"}},"id":"schema_12"}},"exampleStore":{"paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic invalid data":{"value":{"type":"urn:raipartners:api:referral:errors:validation:invalid-data","title":"Bad Request","status":400,"detail":"One or more fields are invalid."},"key":"Generic invalid data","summary":"Generic invalid data","description":"Generic invalid data","id":"paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic invalid data"},"paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic missing data":{"value":{"type":"urn:raipartners:api:referral:errors:validation:missing-data","title":"Bad Request","status":400,"detail":"One or more required fields are missing."},"key":"Generic missing data","summary":"Generic missing data","description":"Generic missing data","id":"paths/~1application~1{product-id}/post/responses/400/content/application~1json/examples/Generic missing data"},"paths/~1application~1{product-id}/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"urn:raipartners:api:referral:errors:not-found","title":"Not Found","status":404,"detail":"Resource not found."},"key":"Not found","summary":"Not found","description":"Not found","id":"paths/~1application~1{product-id}/post/responses/404/content/application~1json/examples/Not found"},"paths/~1application~1{product-id}/post/responses/500/content/application~1json/examples/Internal server error":{"value":{"type":"urn:raipartners:api:referral:errors:internal","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred."},"key":"Internal server error","summary":"Internal server error","description":"Internal server error","id":"paths/~1application~1{product-id}/post/responses/500/content/application~1json/examples/Internal server error"},"paths/~1application~1{product-id}/post/responses/503/content/application~1json/examples/Service unavailable":{"value":{"type":"urn:raipartners:api:referral:errors:internal","title":"Service unavailable Error","status":503,"detail":"Service is unavailable."},"key":"Service unavailable","summary":"Service unavailable","description":"Service unavailable","id":"paths/~1application~1{product-id}/post/responses/503/content/application~1json/examples/Service unavailable"},"paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic invalid data":{"value":{"type":"urn:raipartners:api:referral:errors:validation:invalid-data","title":"Bad Request","status":400,"detail":"One or more fields are invalid."},"key":"Generic invalid data","summary":"Generic invalid data","description":"Generic invalid data","id":"paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic invalid data"},"paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic missing data":{"value":{"type":"urn:raipartners:api:referral:errors:validation:missing-data","title":"Bad Request","status":400,"detail":"One or more required fields are missing."},"key":"Generic missing data","summary":"Generic missing data","description":"Generic missing data","id":"paths/~1spousal-notification-states/get/responses/400/content/application~1json/examples/Generic missing data"},"paths/~1spousal-notification-states/get/responses/404/content/application~1json/examples/Not found":{"value":{"type":"urn:raipartners:api:referral:errors:not-found","title":"Not Found","status":404,"detail":"Resource not found."},"key":"Not found","summary":"Not found","description":"Not found","id":"paths/~1spousal-notification-states/get/responses/404/content/application~1json/examples/Not found"},"paths/~1spousal-notification-states/get/responses/500/content/application~1json/examples/Internal server error":{"value":{"type":"urn:raipartners:api:referral:errors:internal","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred."},"key":"Internal server error","summary":"Internal server error","description":"Internal server error","id":"paths/~1spousal-notification-states/get/responses/500/content/application~1json/examples/Internal server error"},"paths/~1spousal-notification-states/get/responses/503/content/application~1json/examples/Service unavailable":{"value":{"type":"urn:raipartners:api:referral:errors:internal","title":"Service unavailable Error","status":503,"detail":"Service is unavailable."},"key":"Service unavailable","summary":"Service unavailable","description":"Service unavailable","id":"paths/~1spousal-notification-states/get/responses/503/content/application~1json/examples/Service unavailable"},"paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data":{"value":{"type":"urn:raipartners:api:referral:errors:validation:invalid-data","title":"Bad Request","status":400,"detail":"One or more fields are invalid."},"key":"Generic invalid data","summary":"Generic invalid data","description":"Generic invalid data","id":"paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic invalid data"},"paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data":{"value":{"type":"urn:raipartners:api:referral:errors:validation:missing-data","title":"Bad Request","status":400,"detail":"One or more required fields are missing."},"key":"Generic missing data","summary":"Generic missing data","description":"Generic missing data","id":"paths/~1auth~1client-secret~1rotation/post/responses/400/content/application~1json/examples/Generic missing data"},"paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized":{"value":{"type":"urn:raipartners:api:referral:errors:authorization:unauthorized","title":"Unauthorized","status":401,"detail":"You are not authorized to perform this action."},"key":"Unauthorized","summary":"Unauthorized","description":"Unauthorized","id":"paths/~1auth~1client-secret~1rotation/post/responses/401/content/application~1json/examples/Unauthorized"},"paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden":{"value":{"type":"urn:raipartners:api:referral:errors:authorization:forbidden","title":"Forbidden","status":403,"detail":"You are forbidden to perform this action."},"key":"Forbidden","summary":"Forbidden","description":"Forbidden","id":"paths/~1auth~1client-secret~1rotation/post/responses/403/content/application~1json/examples/Forbidden"},"paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"urn:raipartners:api:referral:errors:not-found","title":"Not Found","status":404,"detail":"Resource not found."},"key":"Not found","summary":"Not found","description":"Not found","id":"paths/~1auth~1client-secret~1rotation/post/responses/404/content/application~1json/examples/Not found"},"paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error":{"value":{"type":"urn:raipartners:api:referral:errors:internal","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred."},"key":"Internal server error","summary":"Internal server error","description":"Internal server error","id":"paths/~1auth~1client-secret~1rotation/post/responses/500/content/application~1json/examples/Internal server error"},"paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable":{"value":{"type":"urn:raipartners:api:referral:errors:internal","title":"Service unavailable Error","status":503,"detail":"Service is unavailable."},"key":"Service unavailable","summary":"Service unavailable","description":"Service unavailable","id":"paths/~1auth~1client-secret~1rotation/post/responses/503/content/application~1json/examples/Service unavailable"},"paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data":{"value":{"type":"urn:raipartners:api:referral:errors:validation:invalid-data","title":"Bad Request","status":400,"detail":"One or more fields are invalid."},"key":"Generic invalid data","summary":"Generic invalid data","description":"Generic invalid data","id":"paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic invalid data"},"paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data":{"value":{"type":"urn:raipartners:api:referral:errors:validation:missing-data","title":"Bad Request","status":400,"detail":"One or more required fields are missing."},"key":"Generic missing data","summary":"Generic missing data","description":"Generic missing data","id":"paths/~1auth~1token/post/responses/400/content/application~1json/examples/Generic missing data"},"paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found":{"value":{"type":"urn:raipartners:api:referral:errors:not-found","title":"Not Found","status":404,"detail":"Resource not found."},"key":"Not found","summary":"Not found","description":"Not found","id":"paths/~1auth~1token/post/responses/404/content/application~1json/examples/Not found"},"paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error":{"value":{"type":"urn:raipartners:api:referral:errors:internal","title":"Internal Server Error","status":500,"detail":"An unexpected error occurred."},"key":"Internal server error","summary":"Internal server error","description":"Internal server error","id":"paths/~1auth~1token/post/responses/500/content/application~1json/examples/Internal server error"},"paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable":{"value":{"type":"urn:raipartners:api:referral:errors:internal","title":"Service unavailable Error","status":503,"detail":"Service is unavailable."},"key":"Service unavailable","summary":"Service unavailable","description":"Service unavailable","id":"paths/~1auth~1token/post/responses/503/content/application~1json/examples/Service unavailable"}},"securitySchemeStore":{"bearer-jwt":{"id":"bearer-jwt","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/referral-api-v1","isMockServer":true,"description":"Mock server"},{"url":"https://api.raipartners.com/referral","description":"Production"},{"url":"https://sandbox.raipartners.com/referral","description":"Sandbox"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/apis/referral-api-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/referral-api-v1.json?download"},{"url":"/_bundle/apis/referral-api-v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Referral API","description":"RAI Partners Referral API.\n\n⚠️ **API version 1.0.8 is scheduled for deprecation on 2027-07-01.** \n\nIt will continue to function until then; please migrate to 2.x.x."}},"baseSlug":"/apis/referral-api-v1","routesMapping":{}}